OSID Logo
OSID Specifications
hold rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.rules.HoldEnablerQuery
Implementsosid.OsidEnablerQuery
Description

This is the query for searching hold enablers. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRuledHoldId
Description

Matches enablers mapped to the hold.

Parametersosid.id.IdholdIdthe hold Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT holdId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledHoldIdTerms
Description

Clears the hold Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledHoldQuery
Description

Tests if a HoldQuery is available.

Returnboolean true if a hold query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledHoldQuery
Description

Gets the query for a hold. Multiple retrievals produce a nested OR term.

Returnosid.hold.HoldQuerythe hold query
ErrorsUNIMPLEMENTED supportsRuledHoldQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledHoldQuery() is true.
MethodmatchAnyRuledHold
Description

Matches enablers mapped to any hold.

Parametersbooleanmatch true for enablers mapped to any hold, false to match enablers mapped to no hold
CompliancemandatoryThis method must be implemented.
MethodclearRuledHoldTerms
Description

Clears the hold query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOublietteId
Description

Matches enablers mapped to the oubliette.

Parametersosid.id.IdoublietteIdthe oubliette Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT oublietteId is null
CompliancemandatoryThis method must be implemented.
MethodclearOublietteIdTerms
Description

Clears the oubliette Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsOublietteQuery
Description

Tests if a OublietteQuery is available.

Returnboolean true if an oubliette query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetOublietteQuery
Description

Gets the query for an oubliette. Multiple retrievals produce a nested OR term.

Returnosid.hold.OublietteQuerythe oubliette query
ErrorsUNIMPLEMENTED supportsOublietteQuery() is false
ComplianceoptionalThis method must be implemented if supportsOublietteQuery() is true.
MethodclearOublietteTerms
Description

Clears the oubliette query terms.

CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablerQueryRecord
Description

Gets the hold enabler query record corresponding to the given HoldEnabler record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeholdEnablerRecordTypea hold enabler record type
Returnosid.hold.rules.records.HoldEnablerQueryRecordthe hold enabler query record
ErrorsNULL_ARGUMENT holdEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(holdEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.