Interface | osid.journaling.JournalEntrySearchSession | ||
---|---|---|---|
Implements | osid.journaling.JournalEntryQuerySession | ||
Description |
This session provides methods for searching Journal entries may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getJournalEntrySearch | ||
Description |
Gets a journal entry search. | ||
Return | osid.journaling.JournalEntrySearch | the journal entry search | |
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntrySearchOrder | ||
Description |
Gets a journal entry search order. The | ||
Return | osid.journaling.JournalEntrySearchOrder | the journal entry search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.journaling.JournalEntryQuery | journalEntryQuery | the journal entry query |
osid.journaling.JournalEntrySearch | journalEntrySearch | the journal entry search | |
Return | osid.journaling.JournalEntrySearchResults | the search results | |
Errors | NULL_ARGUMENT | journalEntryQuery or journalEntrySearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | journalEntryQuery or journalEntrySearch is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntryQueryFromInspector | ||
Description |
Gets a journal entry query from an inspector. The
inspector is available from a | ||
Parameters | osid.journaling.JournalEntryQueryInspector | journalEntryQueryInspector | a journal entry query inspector |
Return | osid.journaling.JournalEntryQuery | the journal entry query | |
Errors | NULL_ARGUMENT | journalEntryQueryInspector is null | |
UNSUPPORTED | journalEntryQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |