OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.JournalEntryLookupSession
Implementsosid.OsidSession
Description

This session defines methods for retrieving journal entries. A JournalEntry is a version entry for an OSID Id.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated journal view: All journal entry methods in this session operate, retrieve and pertain to journal entries defined explicitly in the current journal. Using an isolated view is useful for managing journal entries with the JournalEntryAdminSession.
  • federated journal view: All journal entry lookup methods in this session operate, retrieve and pertain to all journal entries defined in this journal and any other journals implicitly available in this journal through journal inheritence.

The methods useFederatedJournalView() and useIsolatedJournalView() behave as a radio group and one should be selected before invoking any lookup methods.

MethodgetJournalId
Description

Gets the Journal Id associated with this session.

Returnosid.id.Idthe Journal Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetJournal
Description

Gets the Journal associated with this session.

Returnosid.journaling.Journalthe journal
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanReadJournal
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations.

Returnboolean false if journal reading methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeJournalEntryView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryJournalEntryView
Description

A complete view of the JournalEntry returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedJournalView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedJournalView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this journal only.

CompliancemandatoryThis method is must be implemented.
MethodgetJournalEntry
Description

Gets the JournalEntry specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned JournalEntry may have a different Id than requested, such as the case where a duplicate Id was assigned to a JournalEntry and retained for compatibility.

Parametersosid.id.IdjournalEntryIdthe Id of the JournalEntry to retrieve
Returnosid.journaling.JournalEntrythe returned JournalEntry
ErrorsNOT_FOUNDno JournalEntry found with the given Id
NULL_ARGUMENT journalEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesByIds
Description

Gets a JournalEntryList corresponding to the given IdList. In plenary mode, the returned list contains all of the entries specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible entries may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListjournalEntryIdsthe list of Ids to retrieve
Returnosid.journaling.JournalEntryListthe returned JournalEntry list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT journalEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesByGenusType
Description

Gets a JournalEntryList corresponding to the given journal entry genus Type which does not include journal entries of genus types derived from the specified Type. 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.

Parametersosid.type.TypejournalEntryGenusTypea journal entry genus type
Returnosid.journaling.JournalEntryListthe returned JournalEntry list
ErrorsNULL_ARGUMENT journalEntryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesByParentGenusType
Description

Gets a JournalEntryList corresponding to the given journal entry genus Type and include any additional journal entries with genus types derived from the specified Type. 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.

Parametersosid.type.TypejournalEntryGenusTypea journal entry genus type
Returnosid.journaling.JournalEntryListthe returned JournalEntry list
ErrorsNULL_ARGUMENT journalEntryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesByRecordType
Description

Gets a JournalEntryList containing the given journal entry record Type. 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.

Parametersosid.type.TypejournalEntryRecordTypea journal entry record type
Returnosid.journaling.JournalEntryListthe returned JournalEntry list
ErrorsNULL_ARGUMENT journalEntryRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesForBranch
Description

Gets a list of journal entries corresponding to a branch Id. 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.

Parametersosid.id.IdbranchIdthe Id of the branch
Returnosid.journaling.JournalEntryListthe returned JournalEntryList
ErrorsNULL_ARGUMENT branchId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesByDateForBranch
Description

Gets the journal entry corresponding to a resource Id and date. The entries returned have a date equal to or more recent than the requested date. 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.

Parametersosid.id.IdbranchIdthe Id of the branch
osid.calendaring.DateTimedatefrom date
Returnosid.journaling.JournalEntryListthe returned JournalEntryList
ErrorsNULL_ARGUMENT branchId or date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesByDateRangeForBranch
Description

Gets a list of journal entries corresponding to a branch Id and date range. Entries are returned with dates that fall between the requested dates inclusive. 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.

Parametersosid.id.IdbranchIdthe Id of the branch
osid.calendaring.DateTimefromfrom date
osid.calendaring.DateTimetoto date
Returnosid.journaling.JournalEntryListthe returned JournalEntryList
ErrorsINVALID_ARGUMENT to is less than from
NULL_ARGUMENT branchId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesForSource
Description

Gets a list of journal entries corresponding to a source Id. A source Id of any version may be requested. 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.

Parametersosid.id.IdsourceIdthe Id of the source
Returnosid.journaling.JournalEntryListthe returned JournalEntryList
ErrorsNULL_ARGUMENT sourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesByDateForSource
Description

Gets the journal entry corresponding to a source Id and date. The entry returned has a date equal to or more recent than the requested date. The sourceId may correspond to any version. 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.

Parametersosid.id.IdsourceIda source Id
osid.calendaring.DateTimedatefrom date
Returnosid.journaling.JournalEntryListthe returned JournalEntryList
ErrorsNULL_ARGUMENT sourceId or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesByDateRangeForSource
Description

Gets a list of journal entries corresponding to a source Id and date range. Entries are returned with dates that fall between the requested dates inclusive. The sourceId may correspond to any version. 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.

Parametersosid.id.IdsourceIda source Id
osid.calendaring.DateTimefromfrom date
osid.calendaring.DateTimetoto date
Returnosid.journaling.JournalEntryListthe returned JournalEntryList
ErrorsINVALID_ARGUMENT to is less than from
NULL_ARGUMENT sourceId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesForBranchAndSource
Description

Gets a list of journal entries corresponding to a branch and source Id. A source Id of any version may be requested. 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.

Parametersosid.id.IdbranchIdthe Id of the branch
osid.id.IdsourceIdthe Id of the source
Returnosid.journaling.JournalEntryListthe returned JournalEntryList
ErrorsNULL_ARGUMENT branchId or sourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesByDateForBranchAndSource
Description

Gets the journal entry corresponding to a branch and source Id and date. The entry returned has a date equal to or more recent than the requested date. The sourceId may correspond to any version. 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.

Parametersosid.id.IdbranchIda branch Id
osid.id.IdsourceIdthe Id of the source
osid.calendaring.DateTimedatefrom date
Returnosid.journaling.JournalEntryListthe returned JournalEntryList
ErrorsNULL_ARGUMENT branchId, sourceId or date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesByDateRangeForBranchAndSource
Description

Gets a list of journal entries corresponding to a branch and source Id and date range. Entries are returned with dates that fall between the requested dates inclusive. The sourceId may correspond to any version 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.

Parametersosid.id.IdbranchIda branch Id
osid.id.IdsourceIdthe Id of the source
osid.calendaring.DateTimefromfrom date
osid.calendaring.DateTimetoto date
Returnosid.journaling.JournalEntryListthe returned JournalEntryList
ErrorsINVALID_ARGUMENT to is less than from
NULL_ARGUMENT branchId, sourceId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesForResource
Description

Gets a list of journal entries corresponding to a resource Id. 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.

Parametersosid.id.IdresourceIdthe Id of the resource
Returnosid.journaling.JournalEntryListthe returned JournalEntryList
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesByDateForResource
Description

Gets the journal entry corresponding to a resource Id and date. The entry returned has a date equal to or more recent than the requested date. 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.

Parametersosid.id.IdresourceIdthe Id of the resource
osid.calendaring.DateTimedatefrom date
Returnosid.journaling.JournalEntryListthe returned JournalEntryList
ErrorsNULL_ARGUMENT resourceId or date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesByDateRangeForResource
Description

Gets a list of journal entries corresponding to a resource Id and date range. Entries are returned with dates that fall between the requested dates inclusive. 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.

Parametersosid.id.IdresourceIdthe Id of the resource
osid.calendaring.DateTimefromfrom date
osid.calendaring.DateTimetoto date
Returnosid.journaling.JournalEntryListthe returned JournalEntryList
ErrorsINVALID_ARGUMENT to is less than from
NULL_ARGUMENT resourceId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntries
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.

Returnosid.journaling.JournalEntryLista list of journal entries
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.