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

This session provides methods for searching among HoldEnabler objects. The search query is constructed using the HoldEnablerQuery.

This session defines views that offer differing behaviors for searching.

  • federated oubliette view: searches include hold enablers in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy
  • isolated oubliette view: searches are restricted to hold enablers in this oubliette

Hold enablers may have a query record indicated by their respective record types. The query record is accessed via the 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.
MethodcanSearchHoldEnablers
Description

Tests if this user can perform HoldEnabler 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 search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedOublietteView
Description

Federates the view for methods in this session. A federated view will include hold enablers in oubliettes which are children of this oubliette in the oubliette hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedOublietteView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this oubliette only.

CompliancemandatoryThis method is must be implemented.
MethodgetHoldEnablerQuery
Description

Gets a hold enabler query.

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

Gets a list of HoldEnablers matching the given hold enabler query.

Parametersosid.hold.rules.HoldEnablerQueryholdEnablerQuerythe hold enabler query
Returnosid.hold.rules.HoldEnablerListthe returned HoldEnablerList
ErrorsNULL_ARGUMENT holdEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED holdEnablerQuery is not of this service
CompliancemandatoryThis method must be implemented.