Interface | osid.journaling.JournalSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing journal searches. | ||
Method | searchAmongJournals | ||
Description |
Execute this search among the given list of journals. | ||
Parameters | osid.id.IdList | journalIds | list of journals |
Errors | NULL_ARGUMENT | journalIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderJournalResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.journaling.JournalSearchOrder | journalSearchOrder | journal search order |
Errors | NULL_ARGUMENT | journalSearchOrder is null | |
UNSUPPORTED | journalSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalSearchRecord | ||
Description |
Gets the journal search record corresponding to the
given journal search record | ||
Parameters | osid.type.Type | journalSearchRecordType | a journal search record type |
Return | osid.journaling.records.JournalSearchRecord | the journal search record | |
Errors | NULL_ARGUMENT | journalSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(journalSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |