OSID - osid.provisioning.rules.PoolProcessorEnablerQuery Service Interface Definition

Interface	osid.provisioning.rules.PoolProcessorEnablerQuery
Implements	`osid.OsidEnablerQuery`
Description	This is the query for searching pool processor enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchRuledPoolProcessorId
Description	Matches enablers mapped to the pool processor.
Parameters	`osid.id.Id`	`poolProcessorId`	the pool processor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`poolProcessorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledPoolProcessorIdTerms
Description	Clears the pool processor `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledPoolProcessorQuery
Description	Tests if a `PoolProcessorQuery` is available.
Return	`boolean`		`true` if a pool processor query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledPoolProcessorQuery
Description	Gets the query for a pool processor. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.rules.PoolProcessorQuery`		the pool processor query
Errors	UNIMPLEMENTED		`supportsRuledPoolProcessorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledPoolProcessorQuery()` is `true.`
Method	matchAnyRuledPoolProcessor
Description	Matches enablers mapped to any pool processor.
Parameters	`boolean`	`match`	`true` for enablers mapped to any pool processor, `false` to match enablers mapped to no pool processors
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledPoolProcessorTerms
Description	Clears the pool processor query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDistributorId
Description	Matches enablers mapped to the distributor.
Parameters	`osid.id.Id`	`distributorId`	the distributor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`distributorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDistributorIdTerms
Description	Clears the distributor `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDistributorQuery
Description	Tests if a `DistributorQuery` is available.
Return	`boolean`		`true` if a distributor query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDistributorQuery
Description	Gets the query for a distributor. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.DistributorQuery`		the distributor query
Errors	UNIMPLEMENTED		`supportsDistributorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDistributorQuery()` is `true.`
Method	clearDistributorTerms
Description	Clears the distributor query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorEnablerQueryRecord
Description	Gets the pool processor enabler query record corresponding to the given `PoolProcessorEnabler` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`poolProcessorEnablerRecordType`	a pool processor enabler record type
Return	`osid.provisioning.rules.records.PoolProcessorEnablerQueryRecord`		the pool processor enabler query record
Errors	NULL_ARGUMENT		`poolProcessorEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(poolProcessorEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.