OSID - osid.process.StateQuery Service Interface Definition

Interface	osid.process.StateQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.OsidObjectQuery`
	`osid.OsidRelationshipQuery`
	`osid.OsidRequestQuery`
	`osid.control.ControllerQuery`
	`osid.control.SettingQuery`
	`osid.control.TriggerQuery`
	`osid.mapping.path.SignalQuery`
	`osid.process.ProcessQuery`
	`osid.process.StateQuerySession`
	`osid.process.StateSearchSession`
	show 2 more…
`osid.workflow.ProcessQuery`
`osid.workflow.StepQuery`
Description	This is the query for searching states. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
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` 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.process.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 terms.
Compliance	`mandatory`		This method must be implemented.
Method	getStateQueryRecord
Description	Gets the state query record corresponding to the given `State` record `Type`.Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`stateRecordType`	a state record type
Return	`osid.process.records.StateQueryRecord`		the state query record
Errors	NULL_ARGUMENT		`stateRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(stateRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.