OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.StepQuery
Implementsosid.OsidGovernatorQuery
osid.OsidSubjugateableQuery
Description

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

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

Sets the resource Id for this query.

Parametersosid.id.IdresourceIdthe resource Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearResourceIdTerms
Description

Clears the resource Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsResourceQuery
Description

Tests if a ResourceQuery is available.

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

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

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsResourceQuery() is false
ComplianceoptionalThis method must be implemented if supportsResourceQuery() is true.
MethodmatchAnyResource
Description

Matches steps that have any resources.

Parametersbooleanmatch true to match steps with any resources, false to match steps with no resources
CompliancemandatoryThis method must be implemented.
MethodclearResourceTerms
Description

Clears the resource query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchInitial
Description

Matches initial steps.

Parametersbooleanmatch true to match initial steps, false otherwise
CompliancemandatoryThis method must be implemented.
MethodclearInitialTerms
Description

Clears the initial step terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTerminal
Description

Matches terminal steps.

Parametersbooleanmatch true to match terminal steps, false otherwise
CompliancemandatoryThis method must be implemented.
MethodclearTerminalTerms
Description

Clears the terminal step terms.

CompliancemandatoryThis method must be implemented.
MethodmatchInputStateId
Description

Sets the input 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.
MethodclearInputStateIdTerms
Description

Clears the input state Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsInputStateQuery
Description

Tests if a StateQuery is available.

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

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

Returnosid.process.StateQuerythe state query
ErrorsUNIMPLEMENTED supportsInputStateQuery() is false
ComplianceoptionalThis method must be implemented if supportsInputtStateQuery() is true.
MethodmatchAnyInputState
Description

Matches steps that have any input states.

Parametersbooleanmatch true to match steps with any input states, false to match steps with no input states
CompliancemandatoryThis method must be implemented.
MethodclearInputStateTerms
Description

Clears the input state terms.

CompliancemandatoryThis method must be implemented.
MethodmatchNextStateId
Description

Sets the next 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.
MethodclearNextStateIdTerms
Description

Clears the next state Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsNextStateQuery
Description

Tests if a StateQuery is available.

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

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

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

Matches steps that have any next state,

Parametersbooleanmatch true to match steps with any next state, false to match steps with no next state
CompliancemandatoryThis method must be implemented.
MethodclearNextStateTerms
Description

Clears the state 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 steps that have any work.

Parametersbooleanmatch true to match steps with any work, false to match steps 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 steps 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.
MethodgetStepQueryRecord
Description

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

Parametersosid.type.TypestepRecordTypea step record type
Returnosid.workflow.records.StepQueryRecordthe step query record
ErrorsNULL_ARGUMENT stepRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(stepRecordType) is false
CompliancemandatoryThis method must be implemented.