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

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

MethodmatchRuledProcessId
Description

Matches enablers mapped to a process.

Parametersosid.id.IdprocessIdthe process Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT processId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledProcessIdTerms
Description

Clears the process Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledProcessQuery
Description

Tests if a ProcessQuery is available.

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

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

Returnosid.workflow.ProcessQuerythe process query
ErrorsUNIMPLEMENTED supportsRuledProcessQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledProcessQuery() is true.
MethodmatchAnyRuledProcess
Description

Matches rules mapped to any process.

Parametersbooleanmatch true for rules mapped to any process, false to match rules mapped to no processs
CompliancemandatoryThis method must be implemented.
MethodclearRuledProcessTerms
Description

Clears the process query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOfficeId
Description

Matches enablers mapped to an 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.
MethodgetProcessEnablerQueryRecord
Description

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

Parametersosid.type.TypeprocessEnablerRecordTypea process enabler record type
Returnosid.workflow.rules.records.ProcessEnablerQueryRecordthe process enabler query record
ErrorsNULL_ARGUMENT processEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(processEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.