OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.WorkQuery
Implementsosid.OsidObjectQuery
Description

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

MethodmatchSuspended
Description

Matches suspended work.

Parametersbooleanmatch true to match suspended work, false otherwise
CompliancemandatoryThis method must be implemented.
MethodclearSuspendedTerms
Description

Clears the suspended query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchProcessId
Description

Sets the process Id for this query.

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

Clears the process Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProcessQuery
Description

Tests if a ProcessQuery is available.

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

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

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

Clears the process query 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.
MethodmatchOfficeId
Description

Sets the office Id for this query to match works 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.
MethodgetWorkQueryRecord
Description

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

Parametersosid.type.TypeworkRecordTypea work record type
Returnosid.workflow.records.WorkQueryRecordthe work query record
ErrorsNULL_ARGUMENT workRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(workRecordType) is false
CompliancemandatoryThis method must be implemented.