Interface | osid.journaling.JournalSearchSession | ||
---|---|---|---|
Implements | osid.journaling.JournalQuerySession | ||
Description |
This session provides methods for searching Journals may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getJournalSearch | ||
Description |
Gets a journal search. | ||
Return | osid.journaling.JournalSearch | the journal search | |
Compliance | mandatory | This method must be implemented. | |
Method | getJournalSearchOrder | ||
Description |
Gets a journal search order. The | ||
Return | osid.journaling.JournalSearchOrder | the journal search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getJournalsBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.journaling.JournalQuery | journalQuery | the journal query |
osid.journaling.JournalSearch | journalSearch | the journal search | |
Return | osid.journaling.JournalSearchResults | the journal search results | |
Errors | NULL_ARGUMENT | journalQuery or journalSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | journalQuery or journalSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalQueryFromInspector | ||
Description |
Gets a journal query from an inspector. The inspector
is available from a | ||
Parameters | osid.journaling.JournalQueryInspector | journalQueryInspector | a journal query inspector |
Return | osid.journaling.JournalQuery | the journal query | |
Errors | NULL_ARGUMENT | journalQueryInspector is null | |
UNSUPPORTED | journalQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |