OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.OfficeQuery
Implementsosid.OsidCatalogQuery
Description

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

MethodmatchProcessId
Description

Sets the step Id for this query to match offices containing 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.
MethodclearProcessIdTerms
Description

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

Matches offices that have any process.

Parametersbooleanmatch true to match offices with any process, false to match offices with no process
CompliancemandatoryThis method must be implemented.
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 an StepQuery is available.

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

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

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

Matches offices with any step.

Parametersbooleanmatch true to match offices with any step, false to match offices 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 offices that have any work.

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

Clears the work query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorOfficeId
Description

Sets the office Id for this query to match offices that have the specified office as an ancestor.

Parametersosid.id.IdofficeIda office Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT officeId is null
CompliancemandatoryThis method must be implemented.
MethodclearAncestorOfficeIdTerms
Description

Clears the ancestor office Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorOfficeQuery
Description

Tests if a OfficeQuery is available.

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

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

Returnosid.workflow.OfficeQuerythe office query
ErrorsUNIMPLEMENTED supportsAncestorOfficeQuery() is false
ComplianceoptionalThis method must be implemented if supportsAncestorOfficeQuery() is true.
MethodmatchAnyAncestorOffice
Description

Matches offices with any ancestor.

Parametersbooleanmatch true to match offices with any ancestor, false to match root offices
CompliancemandatoryThis method must be implemented.
MethodclearAncestorOfficeTerms
Description

Clears the ancestor office query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantOfficeId
Description

Sets the office Id for this query to match offices that have the specified office as a descendant.

Parametersosid.id.IdofficeIda office Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT officeId is null
CompliancemandatoryThis method must be implemented.
MethodclearDescendantOfficeIdTerms
Description

Clears the descendant office Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantOfficeQuery
Description

Tests if a OfficeQuery is available.

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

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

Returnosid.workflow.OfficeQuerythe office query
ErrorsUNIMPLEMENTED supportsDescendantOfficeQuery() is false
ComplianceoptionalThis method must be implemented if supportsDescendantOfficeQuery() is true.
MethodmatchAnyDescendantOffice
Description

Matches offices with any descendant.

Parametersbooleanmatch true to match offices with any descendant, false to match leaf offices
CompliancemandatoryThis method must be implemented.
MethodclearDescendantOfficeTerms
Description

Clears the descendant office query terms.

CompliancemandatoryThis method must be implemented.
MethodgetOfficeQueryRecord
Description

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

Parametersosid.type.TypeofficeRecordTypea office record type
Returnosid.workflow.records.OfficeQueryRecordthe office query record
ErrorsNULL_ARGUMENT officeRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(officeRecordType) is false
CompliancemandatoryThis method must be implemented.