OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.rules.StepConstrainerEnablerQuery
Implementsosid.OsidEnablerQuery
Description

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

MethodmatchRuledStepConstrainerId
Description

Matches enablers mapped to the step constrainer.

Parametersosid.id.IdstepConstrainerIdthe step constrainer Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT stepConstrainerId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledStepConstrainerIdTerms
Description

Clears the step constrainer Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledStepConstrainerQuery
Description

Tests if a StepConstrainerQuery is available.

Returnboolean true if a step constrainer query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledStepConstrainerQuery
Description

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

Returnosid.workflow.rules.StepConstrainerQuerythe step constrainer query
ErrorsUNIMPLEMENTED supportsRuledStepConstrainerQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledStepConstrainerQuery() is true.
MethodmatchAnyRuledStepConstrainer
Description

Matches enablers mapped to any step constrainer.

Parametersbooleanmatch true for enablers mapped to any step constrainer, false to match enablers mapped to no step constrainers
CompliancemandatoryThis method must be implemented.
MethodclearRuledStepConstrainerTerms
Description

Clears the step constrainer query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOfficeId
Description

Matches enablers mapped to the office.

Parametersosid.id.IdofficeIdthe office Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT officeId is null
CompliancemandatoryThis method must be implemented.
MethodclearOfficeIdTerms
Description

Clears the office Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsOfficeQuery
Description

Tests if an OfficeQuery is available.

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

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

Returnosid.workflow.OfficeQuerythe office query
ErrorsUNIMPLEMENTED supportsOfficeQuery() is false
ComplianceoptionalThis method must be implemented if supportsOfficeQuery() is true.
MethodclearOfficeTerms
Description

Clears the office query terms.

CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerEnablerQueryRecord
Description

Gets the step constrainer enabler query record corresponding to the given StepConstrainerEnabler record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypestepConstrainerEnablerRecordTypea step constrainer enabler record type
Returnosid.workflow.rules.records.StepConstrainerEnablerQueryRecordthe step constrainer enabler query record
ErrorsNULL_ARGUMENT stepConstrainerEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(stepConstrainerEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.