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

This session manages queries and sequencing to create "smart" dynamic oubliettes. A HoldEnablerQuery can be retrieved from this session and mapped to this Oubliette to create a virtual collection of hold enablers. The hold enablers may be sequenced using the HoldEnablerSearchOrder from this session.

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

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.
MethodgetHoldEnablerQuery
Description

Gets a hold enabler query.

Returnosid.hold.rules.HoldEnablerQuerythe hold enabler query
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablerSearchOrder
Description

Gets a hold enabler search order.

Returnosid.hold.rules.HoldEnablerSearchOrderthe hold enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyHoldEnablerQuery
Description

Applies a hold enabler query to this oubliette.

Parametersosid.hold.rules.HoldEnablerQueryholdEnablerQuerythe hold enabler query
ErrorsNULL_ARGUMENT holdEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED holdEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectHoldEnablerQuery
Description

Gets a hold enabler query inspector for this oubliette.

Returnosid.hold.rules.HoldEnablerQueryInspectorthe hold enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyHoldEnablerSequencing
Description

Applies a hold enabler search order to this oubliette.

Parametersosid.hold.rules.HoldEnablerSearchOrderholdEnablerSearchOrderthe hold enabler search order
ErrorsNULL_ARGUMENT holdEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED holdEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablerQueryFromInspector
Description

Gets a hold enabler query from an inspector.

Parametersosid.hold.rules.HoldEnablerQueryInspectorholdEnablerQueryInspectora hold enabler query inspector
Returnosid.hold.rules.HoldEnablerQuerythe hold enabler query
ErrorsNULL_ARGUMENT holdEnablerQueryInspector is null
UNSUPPORTED holdEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.