OSID - osid.process.ProcessQuery Service Interface Definition

Interface	osid.process.ProcessQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching processes. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchStateId
Description	Sets the state `Id` for this query.
Parameters	`osid.id.Id`	`stateId`	a 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	clearStateIdTerms
Description	Clears the state `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsStateQuery
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	getStateQuery
Description	Gets the query for a state. Multiple retrievals produce a nested `OR` term.
Return	`osid.process.StateQuery`		the state query
Errors	UNIMPLEMENTED		`supportsStateQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateQuery()` is `true.`
Method	matchAnyState
Description	Matches processes with any states.
Parameters	`boolean`	`match`	`true` to match processes with any states, `false` to match processes with no states
Compliance	`mandatory`		This method must be implemented.
Method	clearStateTerms
Description	Clears the state terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorProcessId
Description	Sets the process `Id` for this query to match processes that have the specified process as an ancestor.
Parameters	`osid.id.Id`	`processId`	a 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	clearAncestorProcessIdTerms
Description	Clears the ancestor process `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorProcessQuery
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	getAncestorProcessQuery
Description	Gets the query for a process. Multiple retrievals produce a nested `OR` term.
Return	`osid.process.ProcessQuery`		the process query
Errors	UNIMPLEMENTED		`supportsAncestorProcessQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorProcessQuery()` is `true.`
Method	matchAnyAncestorProcess
Description	Matches processes with any ancestor.
Parameters	`boolean`	`match`	`true` to match process with any ancestor, `false` to match root processes
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorProcessTerms
Description	Clears the ancestor process terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantProcessId
Description	Sets the process `Id` for this query to match that have the specified process as a descendant.
Parameters	`osid.id.Id`	`processId`	a 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	clearDescendantProcessIdTerms
Description	Clears the descendant process `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantProcessQuery
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	getDescendantProcessQuery
Description	Gets the query for a process. Multiple retrievals produce a nested `OR` term.
Return	`osid.process.ProcessQuery`		the process query
Errors	UNIMPLEMENTED		`supportsDescendantProcessQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantProcessQuery()` is `true.`
Method	matchAnyDescendantProcess
Description	Matches processes with any descendant.
Parameters	`boolean`	`match`	`true` to match process with any descendant, `false` to match leaf processes
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantProcessTerms
Description	Clears the descendant process terms.
Compliance	`mandatory`		This method must be implemented.
Method	getProcessQueryRecord
Description	Gets the process query record corresponding to the given `Process` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`processRecordType`	a process record type
Return	`osid.process.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.