Interface | osid.journaling.JournalEntrySearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing journal entry searches. | ||
Method | searchAmongJournalEntries | ||
Description |
Execute this search among the given list of journal entries. | ||
Parameters | osid.id.IdList | journalEntryIds | list of journal entries |
Errors | NULL_ARGUMENT | journalEntryIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderJournalEntryResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.journaling.JournalEntrySearchOrder | journalEntrySearchOrder | journal entry search order |
Errors | NULL_ARGUMENT | journalEntrySearchOrder is null | |
UNSUPPORTED | journalEntrySearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntrySearchRecord | ||
Description |
Gets the journal entry search record corresponding to
the given journal entry search record | ||
Parameters | osid.type.Type | journalEntrySearchRecordType | a journal entry search record type |
Return | osid.journaling.records.JournalEntrySearchRecord | the journal entry search record | |
Errors | NULL_ARGUMENT | journalEntrySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(journalEntrySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |