public interface JournalSearch extends OsidSearch
The search interface for governing journal searches.
Modifier and Type | Method and Description |
---|---|
JournalSearchRecord |
getJournalSearchRecord(Type journalSearchRecordType)
Gets the journal search record corresponding to the given journal
search record
Type. |
void |
orderJournalResults(JournalSearchOrder journalSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongJournals(IdList journalIds)
Execute this search among the given list of journals.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongJournals(IdList journalIds)
journalIds
- list of journalsNullArgumentException
- journalIds
is
null
mandatory
- This method must be implemented. void orderJournalResults(JournalSearchOrder journalSearchOrder)
journalSearchOrder
- journal search orderNullArgumentException
- journalSearchOrder
is null
UnsupportedException
- journalSearchOrder
is not of this servicemandatory
- This method must be implemented. JournalSearchRecord getJournalSearchRecord(Type journalSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.journalSearchRecordType
- a journal search record typeNullArgumentException
- journalSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(journalSearchRecordType)
is false
mandatory
- This method must be implemented.