OSID Logo
OSID Specifications
sequencing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.sequencing.ChainSmartAntimatroidSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. A ChainQuery can be retrieved from this session and antimatroidped to this Antimatroid to create a virtual collection of Chains. The chains may be sequenced using the ChainSearchOrder from this session.

This Antimatroid has a default query that matches any chain and a default search order that specifies no sequencing. The queries may be examined using a ChainQueryInspector. The query may be modified by converting the inspector back to a ChainQuery.

MethodgetAntimatroidId
Description

Gets the Antimatroid Id associated with this session.

Returnosid.id.Idthe Antimatroid Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAntimatroid
Description

Gets the Antimatroid associated with this session.

Returnosid.sequencing.Antimatroidthe antimatroid
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartAntimatroids
Description

Tests if this user can manage smart antimatroids. 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 antimatroid management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetChainQuery
Description

Gets a chain query.

Returnosid.sequencing.ChainQuerythe chain query
CompliancemandatoryThis method must be implemented.
MethodgetChainSearchOrder
Description

Gets a chain search order.

Returnosid.sequencing.ChainSearchOrderthe chain search order
CompliancemandatoryThis method must be implemented.
MethodapplyChainQuery
Description

Applies a chain query to this antimatroid.

Parametersosid.sequencing.ChainQuerychainQuerythe chain query
ErrorsNULL_ARGUMENT chainQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED chainQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectChainQuery
Description

Gets a chain query inspector for this antimatroid.

Returnosid.sequencing.ChainQueryInspectorthe chain query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyChainSequencing
Description

Applies a chain search order to this antimatroid.

Parametersosid.sequencing.ChainSearchOrderchainSearchOrderthe chain search order
ErrorsNULL_ARGUMENT chainSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED chainSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetChainQueryFromInspector
Description

Gets a chain query from an inspector.

Parametersosid.sequencing.ChainQueryInspectorchainQueryInspectora chain query inspector
Returnosid.sequencing.ChainQuerythe chain query
ErrorsNULL_ARGUMENT chainQueryInspector is null
UNSUPPORTED chainQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.