OSID - osid.workflow.ProcessQuery Service Interface Definition

Interface	osid.workflow.ProcessQuery
Implements	`osid.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.`
Method	matchEnabled
Description	Matches enabled processes.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearEnabledTerms
Description	Clears the enabled query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchInitialStepId
Description	Sets the initial step `Id` for this query.
Parameters	`osid.id.Id`	`stepId`	the step `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`stepId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearInitialStepIdTerms
Description	Clears the initial stap `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsInitialStepQuery
Description	Tests if a `StepQuery` is available.
Return	`boolean`		`true` if a step query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInitialStepQuery
Description	Gets the query for a step. Multiple retrievals produce a nested `OR` term.
Return	`osid.workflow.StepQuery`		the step query
Errors	UNIMPLEMENTED		`supportsInitialStepQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInitialStepQuery()` is `true.`
Method	clearInitialStepTerms
Description	Clears the initial step terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchInitialStateId
Description	Sets the initial state `Id` for this query.
Parameters	`osid.id.Id`	`stateId`	the state `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`stateId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearInitialStateIdTerms
Description	Clears the initial state `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsInitialStateQuery
Description	Tests if a `StateQuery` is available.
Return	`boolean`		`true` if a state query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInitialStateQuery
Description	Gets the query for a state. Multiple retrievals produce a nested `OR` term.
Return	`osid.process.StateQuery`		the state query
Errors	UNIMPLEMENTED		`supportsInitialStateQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInitialStateQuery()` is `true.`
Method	clearInitialStateTerms
Description	Clears the state terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStepId
Description	Sets the step `Id` for this query.
Parameters	`osid.id.Id`	`stepId`	the step `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`stepId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearStepIdTerms
Description	Clears the step `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsStepQuery
Description	Tests if a `StepQuery` is available.
Return	`boolean`		`true` if a step query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStepQuery
Description	Gets the query for a step Multiple retrievals produce a nested `OR` term.
Return	`osid.workflow.StepQuery`		the step query
Errors	UNIMPLEMENTED		`supportsStepyQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStepQuery()` is `true.`
Method	matchAnyStep
Description	Matches processes that have any step.
Parameters	`boolean`	`match`	`true` to match processes with any step, `false` to match processes with no step
Compliance	`mandatory`		This method must be implemented.
Method	clearStepTerms
Description	Clears the step query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchWorkId
Description	Sets the work `Id` for this query.
Parameters	`osid.id.Id`	`workId`	the work `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`workId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearWorkIdTerms
Description	Clears the work `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkQuery
Description	Tests if a `WorkQuery` is available.
Return	`boolean`		`true` if a work query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getWorkQuery
Description	Gets the query for a work. Multiple retrievals produce a nested `OR` term.
Return	`osid.workflow.WorkQuery`		the work query
Errors	UNIMPLEMENTED		`supportsWorkQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkQuery()` is `true.`
Method	matchAnyWork
Description	Matches processs that have any work.
Parameters	`boolean`	`match`	`true` to match processes with any work, `false` to match processes with no work
Compliance	`mandatory`		This method must be implemented.
Method	clearWorkTerms
Description	Clears the work query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOfficeId
Description	Sets the office `Id` for this query to match process assigned to offices.
Parameters	`osid.id.Id`	`officeId`	the office `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`officeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearOfficeIdTerms
Description	Clears the office `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfficeQuery
Description	Tests if a `OfficeQuery` is available.
Return	`boolean`		`true` if a office query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOfficeQuery
Description	Gets the query for a office. Multiple retrievals produce a nested `OR` term.
Return	`osid.workflow.OfficeQuery`		the office query
Errors	UNIMPLEMENTED		`supportsOfficeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOfficeQuery()` is `true.`
Method	clearOfficeTerms
Description	Clears the office query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getProcessQueryRecord
Description	Gets the process query record corresponding to the given `Process` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`processRecordType`	a process record type
Return	`osid.workflow.records.ProcessQueryRecord`		the process query record
Errors	NULL_ARGUMENT		`processRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(processRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.