OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.rules.StepConstrainerQuery
Implementsosid.OsidConstrainerQuery
Description

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

MethodmatchRuledStepId
Description

Matches mapped to a step.

Parametersosid.id.IdstepIdthe step Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT stepId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledStepIdTerms
Description

Clears the step Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledStepQuery
Description

Tests if a StepQuery is available.

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

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

Returnosid.workflow.StepQuerythe step query
ErrorsUNIMPLEMENTED supportsRuledStepQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledStepQuery() is true.
MethodmatchAnyRuledStep
Description

Matches constrainers mapped to any step.

Parametersbooleanmatch true for constrainers mapped to any step, false to match constrainers mapped to no steps
CompliancemandatoryThis method must be implemented.
MethodclearRuledStepTerms
Description

Clears the step query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOfficeId
Description

Matches constrainers 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.
MethodgetStepConstrainerQueryRecord
Description

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

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