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

This session manages queries and sequencing to create "smart" dynamic catalogs. A BranchQuery can be retrieved from this session and mapped to this Journal to create a virtual collection of Branches. The branches may be sequenced using the BranchSearchOrder from this session.

This Journal has a default query that matches any branch and a default search order that specifies no sequencing. The queries may be examined using a BranchQueryInspector. The query may be modified by converting the inspector back to a BranchQuery.

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 associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartJournals
Description

Tests if this user can manage smart journals. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart journal management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBranchQuery
Description

Gets a branch query.

Returnosid.journaling.BranchQuerythe branch query
CompliancemandatoryThis method must be implemented.
MethodgetBranchSearchOrder
Description

Gets a branch search order.

Returnosid.journaling.BranchSearchOrderthe branch search order
CompliancemandatoryThis method must be implemented.
MethodapplyBranchQuery
Description

Applies a branch query to this journal.

Parametersosid.journaling.BranchQuerybranchQuerythe branch query
ErrorsNULL_ARGUMENT branchQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED branchQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectBranchQuery
Description

Gets a branch query inspector for this journal.

Returnosid.journaling.BranchQueryInspectorthe branch query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyBranchSequencing
Description

Applies a branch search order to this journal.

Parametersosid.journaling.BranchSearchOrderbranchSearchOrderthe branch search order
ErrorsNULL_ARGUMENT branchSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED branchSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBranchQueryFromInspector
Description

Gets a branch query from an inspector.

Parametersosid.journaling.BranchQueryInspectorbranchQueryInspectora branch query inspector
Returnosid.journaling.BranchQuerythe branch query
ErrorsNULL_ARGUMENT branchQueryInspector is null
UNSUPPORTED branchQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.