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

This session provides methods for retrieving Journal objects. The Journal represents a collection of journal entries.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
MethodcanLookupJournals
Description

Tests if this user can perform Journal lookups. 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 not offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeJournalView
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.
MethodusePlenaryJournalView
Description

A complete view of the Journal 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.
MethodgetJournal
Description

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

Parametersosid.id.IdjournalId Id of the Journal
Returnosid.journaling.Journalthe journal
ErrorsNOT_FOUND journalId not found
NULL_ARGUMENT journalId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetJournalsByIds
Description

Gets a JournalList corresponding to the given IdList. In plenary mode, the returned list contains all of the journals 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 Journals may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListjournalIdsthe list of Ids to retrieve
Returnosid.journaling.JournalListthe returned Journal list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT journalIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalsByGenusType
Description

Gets a JournalList corresponding to the given journal genus Type which does not include journals of genus types derived from the specified Type. In plenary mode, the returned list contains all known journals or an error results. Otherwise, the returned list may contain only those journals that are accessible through this session.

Parametersosid.type.TypejournalGenusTypea journal genus type
Returnosid.journaling.JournalListthe returned Journal list
ErrorsNULL_ARGUMENT journalGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalsByParentGenusType
Description

Gets a JournalList corresponding to the given journal genus Type and include any additional journals with genus types derived from the specified Type. In plenary mode, the returned list contains all known journals or an error results. Otherwise, the returned list may contain only those journals that are accessible through this session.

Parametersosid.type.TypejournalGenusTypea journal genus type
Returnosid.journaling.JournalListthe returned Journal list
ErrorsNULL_ARGUMENT journalGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalsByRecordType
Description

Gets a JournalList containing the given journal record Type. In plenary mode, the returned list contains all known journals or an error results. Otherwise, the returned list may contain only those journals that are accessible through this session.

Parametersosid.type.TypejournalRecordTypea journal record type
Returnosid.journaling.JournalListthe returned Journal list
ErrorsNULL_ARGUMENT journalRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalsByProvider
Description

Gets a JournalList for the given provider. In plenary mode, the returned list contains all known journals or an error results. Otherwise, the returned list may contain only those journals that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.journaling.JournalListthe returned Journal list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournals
Description

Gets all Journals. In plenary mode, the returned list contains all known journals or an error results. Otherwise, the returned list may contain only those journals that are accessible through this session.

Returnosid.journaling.JournalLista list of Journals
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.