Interface | osid.journaling.JournalEntryLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving journal
entries. A This lookup session defines several views:
The methods | ||
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 | canReadJournal | ||
Description |
Tests if this user can examine this journal. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known all methods in
this session will result in a | ||
Return | boolean | false if journal reading methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeJournalEntryView | ||
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 | usePlenaryJournalEntryView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is 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 retrievals to this journal only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getJournalEntry | ||
Description |
Gets the | ||
Parameters | osid.id.Id | journalEntryId | the Id of the JournalEntry to retrieve |
Return | osid.journaling.JournalEntry | the returned JournalEntry | |
Errors | NOT_FOUND | no JournalEntry found with the given Id | |
NULL_ARGUMENT | journalEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | journalEntryIds | the list of Ids to retrieve |
Return | osid.journaling.JournalEntryList | the returned JournalEntry list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | journalEntryIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | journalEntryGenusType | a journal entry genus type |
Return | osid.journaling.JournalEntryList | the returned JournalEntry list | |
Errors | NULL_ARGUMENT | journalEntryGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | journalEntryGenusType | a journal entry genus type |
Return | osid.journaling.JournalEntryList | the returned JournalEntry list | |
Errors | NULL_ARGUMENT | journalEntryGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | journalEntryRecordType | a journal entry record type |
Return | osid.journaling.JournalEntryList | the returned JournalEntry list | |
Errors | NULL_ARGUMENT | journalEntryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesForBranch | ||
Description |
Gets a list of journal entries corresponding to a
branch | ||
Parameters | osid.id.Id | branchId | the Id of the branch |
Return | osid.journaling.JournalEntryList | the returned JournalEntryList | |
Errors | NULL_ARGUMENT | branchId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesByDateForBranch | ||
Description |
Gets the journal entry corresponding to a resource
| ||
Parameters | osid.id.Id | branchId | the Id of the branch |
osid.calendaring.DateTime | date | from date | |
Return | osid.journaling.JournalEntryList | the returned JournalEntryList | |
Errors | NULL_ARGUMENT | branchId or date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesByDateRangeForBranch | ||
Description |
Gets a list of journal entries corresponding to a
branch | ||
Parameters | osid.id.Id | branchId | the Id of the branch |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.journaling.JournalEntryList | the returned JournalEntryList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | branchId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesForSource | ||
Description |
Gets a list of journal entries corresponding to a
source | ||
Parameters | osid.id.Id | sourceId | the Id of the source |
Return | osid.journaling.JournalEntryList | the returned JournalEntryList | |
Errors | NULL_ARGUMENT | sourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesByDateForSource | ||
Description |
Gets the journal entry corresponding to a source | ||
Parameters | osid.id.Id | sourceId | a source Id |
osid.calendaring.DateTime | date | from date | |
Return | osid.journaling.JournalEntryList | the returned JournalEntryList | |
Errors | NULL_ARGUMENT | sourceId or to is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesByDateRangeForSource | ||
Description |
Gets a list of journal entries corresponding to a
source | ||
Parameters | osid.id.Id | sourceId | a source Id |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.journaling.JournalEntryList | the returned JournalEntryList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | sourceId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesForBranchAndSource | ||
Description |
Gets a list of journal entries corresponding to a
branch and source | ||
Parameters | osid.id.Id | branchId | the Id of the branch |
osid.id.Id | sourceId | the Id of the source | |
Return | osid.journaling.JournalEntryList | the returned JournalEntryList | |
Errors | NULL_ARGUMENT | branchId or sourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesByDateForBranchAndSource | ||
Description |
Gets the journal entry corresponding to a branch and
source | ||
Parameters | osid.id.Id | branchId | a branch Id |
osid.id.Id | sourceId | the Id of the source | |
osid.calendaring.DateTime | date | from date | |
Return | osid.journaling.JournalEntryList | the returned JournalEntryList | |
Errors | NULL_ARGUMENT | branchId, sourceId or date is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesByDateRangeForBranchAndSource | ||
Description |
Gets a list of journal entries corresponding to a
branch and source | ||
Parameters | osid.id.Id | branchId | a branch Id |
osid.id.Id | sourceId | the Id of the source | |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.journaling.JournalEntryList | the returned JournalEntryList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | branchId, sourceId, from or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesForResource | ||
Description |
Gets a list of journal entries corresponding to a
resource | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
Return | osid.journaling.JournalEntryList | the returned JournalEntryList | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesByDateForResource | ||
Description |
Gets the journal entry corresponding to a resource
| ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
osid.calendaring.DateTime | date | from date | |
Return | osid.journaling.JournalEntryList | the returned JournalEntryList | |
Errors | NULL_ARGUMENT | resourceId or date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntriesByDateRangeForResource | ||
Description |
Gets a list of journal entries corresponding to a
resource | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.journaling.JournalEntryList | the returned JournalEntryList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | resourceId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntries | ||
Description |
Gets all journal entries. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In both cases, the order of the set is not specifed. In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session. | ||
Return | osid.journaling.JournalEntryList | a list of journal entries | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |