Interface | osid.journaling.JournalLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | canLookupJournals | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeJournalView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryJournalView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getJournal | ||
Description |
Gets the | ||
Parameters | osid.id.Id | journalId | Id of the Journal |
Return | osid.journaling.Journal | the journal | |
Errors | NOT_FOUND | journalId not found | |
NULL_ARGUMENT | journalId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getJournalsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | journalIds | the list of Ids to retrieve |
Return | osid.journaling.JournalList | the returned Journal list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | journalIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | journalGenusType | a journal genus type |
Return | osid.journaling.JournalList | the returned Journal list | |
Errors | NULL_ARGUMENT | journalGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | journalGenusType | a journal genus type |
Return | osid.journaling.JournalList | the returned Journal list | |
Errors | NULL_ARGUMENT | journalGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalsByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | journalRecordType | a journal record type |
Return | osid.journaling.JournalList | the returned Journal list | |
Errors | NULL_ARGUMENT | journalRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalsByProvider | ||
Description |
Gets a | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.journaling.JournalList | the returned Journal list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournals | ||
Description |
Gets all | ||
Return | osid.journaling.JournalList | a list of Journals | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |