OSID - osid.workflow.rules.StepProcessorQuery Service Interface Definition

Interface	osid.workflow.rules.StepProcessorQuery
Implements	`osid.OsidProcessorQuery`
Used By	`osid.workflow.rules.StepProcessorEnablerQuery`
	`osid.workflow.rules.StepProcessorQuerySession`
	`osid.workflow.rules.StepProcessorSearchSession`
	`osid.workflow.rules.StepProcessorSmartOfficeSession`
Description	This is the query for searching step processors. Each method match specifies a `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledStepId
Description	Matches rules mapped to the step.
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	clearRuledStepIdTerms
Description	Clears the step `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledStepQuery
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	getRuledStepQuery
Description	Gets the query for a step. Multiple retrievals produce a nested `OR` term.
Return	`osid.workflow.StepQuery`		the step query
Errors	UNIMPLEMENTED		`supportsRuledStepQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledStepQuery()` is `true`.
Method	matchAnyRuledStep
Description	Matches any rule mapped to any step.
Parameters	`boolean`	`match`	`true` for rules mapped to any step, `false` to match rules mapped to no step
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledStepTerms
Description	Clears the step query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOfficeId
Description	Matches rules mapped to the office.
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	getStepProcessorQueryRecord
Description	Gets the step processor query record corresponding to the given `StepProcessor` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`stepProcessorRecordType`	a step processor record type
Return	`osid.workflow.rules.records.StepProcessorQueryRecord`		the step processor query record
Errors	NULL_ARGUMENT		`stepProcessorRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(stepProcessorRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.