OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.BlockSmartOublietteSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. A BlockQuery can be retrieved from this session and mapped to this Oubliette to create a virtual collection of Blocks. The blocks may be sequenced using the BlockSearchOrder from this session.

This Oubliette has a default query that matches any block and a default search order that specifies no sequencing. The queries may be examined using a BlockQueryInspector. The query may be modified by converting the inspector back to a BlockQuery.

MethodgetOublietteId
Description

Gets the Oubliette Id associated with this session.

Returnosid.id.Idthe Oubliette Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOubliette
Description

Gets the Oubliette associated with this session.

Returnosid.hold.Oubliettethe oubliette
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartOubliettes
Description

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

Gets a block query.

Returnosid.hold.BlockQuerythe block query
CompliancemandatoryThis method must be implemented.
MethodgetBlockSearchOrder
Description

Gets a block search order.

Returnosid.hold.BlockSearchOrderthe block search order
CompliancemandatoryThis method must be implemented.
MethodapplyBlockQuery
Description

Applies a block query to this oubliette.

Parametersosid.hold.BlockQueryblockQuerythe block query
ErrorsNULL_ARGUMENT blockQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED blockQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectBlockQuery
Description

Gets a block query inspector for this oubliette.

Returnosid.hold.BlockQueryInspectorthe block query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyBlockSequencing
Description

Applies a block search order to this oubliette.

Parametersosid.hold.BlockSearchOrderblockSearchOrderthe block search order
ErrorsNULL_ARGUMENT blockSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED blockSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBlockQueryFromInspector
Description

Gets a block query from an inspector.

Parametersosid.hold.BlockQueryInspectorblockQueryInspectora block query inspector
Returnosid.hold.BlockQuerythe block query
ErrorsNULL_ARGUMENT blockQueryInspector is null
UNSUPPORTED blockQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.