OSID - osid.workflow.WorkQuery Service Interface Definition

Interface	osid.workflow.WorkQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.workflow.OfficeQuery`
	`osid.workflow.ProcessQuery`
	`osid.workflow.StepQuery`
	`osid.workflow.WorkQuerySession`
	`osid.workflow.WorkSearchSession`
	`osid.workflow.WorkSmartOfficeSession`
	`osid.workflow.event.WorkflowEventQuery`
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`.
Method	matchSuspended
Description	Matches suspended work.
Parameters	`boolean`	`match`	`true` to match suspended work, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearSuspendedTerms
Description	Clears the suspended query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProcessId
Description	Sets the process `Id` for this query.
Parameters	`osid.id.Id`	`processId`	the process `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`processId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProcessIdTerms
Description	Clears the process `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessQuery
Description	Tests if a `ProcessQuery` is available.
Return	`boolean`		`true` if a process query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProcessQuery
Description	Gets the query for a process. Multiple retrievals produce a nested `OR` term.
Return	`osid.workflow.ProcessQuery`		the process query
Errors	UNIMPLEMENTED		`supportsProcessQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProcessQuery()` is `true`.
Method	clearProcessTerms
Description	Clears the process query 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	matchOfficeId
Description	Sets the office `Id` for this query to match works 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 an `OfficeQuery` is available.
Return	`boolean`		`true` if an office query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOfficeQuery
Description	Gets the query for an 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	getWorkQueryRecord
Description	Gets the work query record corresponding to the given `Work` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`workRecordType`	a work record type
Return	`osid.workflow.records.WorkQueryRecord`		the work query record
Errors	NULL_ARGUMENT		`workRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(workRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.