OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.ProcessQuery
Implementsosid.OsidGovernatorQuery
Description

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

MethodmatchEnabled
Description

Matches enabled processes.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearEnabledTerms
Description

Clears the enabled query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchInitialStepId
Description

Sets the initial step Id for this query.

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.
MethodclearInitialStepIdTerms
Description

Clears the initial stap Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsInitialStepQuery
Description

Tests if a StepQuery is available.

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

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

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

Clears the initial step terms.

CompliancemandatoryThis method must be implemented.
MethodmatchInitialStateId
Description

Sets the initial state Id for this query.

Parametersosid.id.IdstateIdthe state Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT stateId is null
CompliancemandatoryThis method must be implemented.
MethodclearInitialStateIdTerms
Description

Clears the initial state Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsInitialStateQuery
Description

Tests if a StateQuery is available.

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

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

Returnosid.process.StateQuerythe state query
ErrorsUNIMPLEMENTED supportsInitialStateQuery() is false
ComplianceoptionalThis method must be implemented if supportsInitialStateQuery() is true.
MethodclearInitialStateTerms
Description

Clears the state terms.

CompliancemandatoryThis method must be implemented.
MethodmatchStepId
Description

Sets the step Id for this query.

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.
MethodclearStepIdTerms
Description

Clears the step Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsStepQuery
Description

Tests if a StepQuery is available.

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

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

Returnosid.workflow.StepQuerythe step query
ErrorsUNIMPLEMENTED supportsStepyQuery() is false
ComplianceoptionalThis method must be implemented if supportsStepQuery() is true.
MethodmatchAnyStep
Description

Matches processes that have any step.

Parametersbooleanmatch true to match processes with any step, false to match processes with no step
CompliancemandatoryThis method must be implemented.
MethodclearStepTerms
Description

Clears the step query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWorkId
Description

Sets the work Id for this query.

Parametersosid.id.IdworkIdthe work Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT workId is null
CompliancemandatoryThis method must be implemented.
MethodclearWorkIdTerms
Description

Clears the work Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsWorkQuery
Description

Tests if a WorkQuery is available.

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

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

Returnosid.workflow.WorkQuerythe work query
ErrorsUNIMPLEMENTED supportsWorkQuery() is false
ComplianceoptionalThis method must be implemented if supportsWorkQuery() is true.
MethodmatchAnyWork
Description

Matches processs that have any work.

Parametersbooleanmatch true to match processes with any work, false to match processes with no work
CompliancemandatoryThis method must be implemented.
MethodclearWorkTerms
Description

Clears the work query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOfficeId
Description

Sets the office Id for this query to match process assigned to offices.

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 a OfficeQuery is available.

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

Gets the query for a 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.
MethodgetProcessQueryRecord
Description

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

Parametersosid.type.TypeprocessRecordTypea process record type
Returnosid.workflow.records.ProcessQueryRecordthe process query record
ErrorsNULL_ARGUMENT processRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(processRecordType) is false
CompliancemandatoryThis method must be implemented.