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

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

MethodmatchRuledStepProcessorId
Description

Matches enablers mapped to the step processor.

Parametersosid.id.IdstepProcessorIdthe step processor Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT stepProcessorId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledStepProcessorIdTerms
Description

Clears the step processor Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledStepProcessorQuery
Description

Tests if a StepProcessorQuery is available.

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

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

Returnosid.workflow.rules.StepProcessorQuerythe step processor query
ErrorsUNIMPLEMENTED supportsRuledStepProcessorQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledStepProcessorQuery() is true.
MethodmatchAnyRuledStepProcessor
Description

Matches enablers mapped to any step processor.

Parametersbooleanmatch true for enablers mapped to any step processor, false to match enablers mapped to no step processors
CompliancemandatoryThis method must be implemented.
MethodclearRuledStepProcessorTerms
Description

Clears the step processor 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.
MethodgetStepProcessorEnablerQueryRecord
Description

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

Parametersosid.type.TypestepProcessorEnablerRecordTypea step processor enabler record type
Returnosid.workflow.rules.records.StepProcessorEnablerQueryRecordthe step processor enabler query record
ErrorsNULL_ARGUMENT stepProcessorEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(stepProcessorEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.