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

Interface	osid.workflow.rules.ProcessConstrainerEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.workflow.rules.ProcessConstrainerEnablerQuerySession`
	`osid.workflow.rules.ProcessConstrainerEnablerSearchSession`
	`osid.workflow.rules.ProcessConstrainerEnablerSmartOfficeSession`
Description	This is the query for searching process constrainer enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchRuledProcessConstrainerId
Description	Matches enablers mapped to a process constrainer.
Parameters	`osid.id.Id`	`processConstrainerId`	the process constrainer `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`processConstrainerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledProcessConstrainerIdTerms
Description	Clears the process constrainer `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledProcessConstrainerQuery
Description	Tests if a `ProcessConstrainerQuery` is available.
Return	`boolean`		`true` if a process constrainer query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledProcessConstrainerQuery
Description	Gets the query for a process constrainer. Multiple retrievals produce a nested `OR` term.
Return	`osid.workflow.rules.ProcessConstrainerQuery`		the process query
Errors	UNIMPLEMENTED		`supportsRuledProcessConstrainerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledProcessConstrainerQuery()` is `true` .
Method	matchAnyRuledProcessConstrainer
Description	Matches rules mapped to any process constrainer.
Parameters	`boolean`	`match`	`true` for rules mapped to any process constrainer, `false` to match rules mapped to no processs constrainer
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledProcessConstrainerTerms
Description	Clears the process constrainer query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOfficeId
Description	Sets the office `Id` for this query to match processes 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	getProcessConstrainerEnablerQueryRecord
Description	Gets the process constrainer enabler query record corresponding to the given `ProcessConstrainerEnabler` record `Type` . Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`processConstrainerEnablerRecordType`	a process constrainer enabler record type
Return	`osid.workflow.rules.records.ProcessConstrainerEnablerQueryRecord`		the process constrainer enabler query record
Errors	NULL_ARGUMENT		`processConstrainerEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(processConstrainerEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.