Interface | osid.journaling.JournalEntryQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
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 | getJournalId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Journal Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getJournal | ||
Description |
Gets the | ||
Return | osid.journaling.Journal | the journal | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchJournalEntries | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedJournalView | ||
Description |
Federates the view for methods in this session. A federated view will include entries in journals which are children of this journal in the journal hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedJournalView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts searches to this journal only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getJournalEntryQuery | ||
Description |
Gets a journal entry query. | ||
Return | osid.journaling.JournalEntryQuery | the journal entry query | |
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesByQuery | ||
Description |
Gets a list of journal entries matching the given journal entry query. | ||
Parameters | osid.journaling.JournalEntryQuery | journalEntryQuery | the journal entry query |
Return | osid.journaling.JournalEntryList | the returned JournalEntryList | |
Errors | NULL_ARGUMENT | journalEntryQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | journalQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |