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

Interface	osid.provisioning.rules.PoolProcessorQuery
Implements	`osid.OsidProcessorQuery`
Used By	`osid.provisioning.rules.PoolProcessorEnablerQuery`
	`osid.provisioning.rules.PoolProcessorQuerySession`
	`osid.provisioning.rules.PoolProcessorSearchSession`
	`osid.provisioning.rules.PoolProcessorSmartDistributorSession`
Description	This is the query for searching pool processors. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchAllocatesByLeastUse
Description	Matches pools that allocate by least use.
Parameters	`boolean`	`match`	`true` to match pool allocators that allocate by least use, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearAllocatesByLeastUseTerms
Description	Clears the allocate by least use query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAllocatesByMostUse
Description	Matches pools that allocate by most use.
Parameters	`boolean`	`match`	`true` to match pool allocators that allocate by most use, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearAllocatesByMostUseTerms
Description	Clears the allocate by most use query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAllocatesByLeastCost
Description	Matches pools that allocate by least cost.
Parameters	`boolean`	`match`	`true` to match pool allocators that allocate by least cost, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearAllocatesByLeastCostTerms
Description	Clears the allocate by most cost query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAllocatesByMostCost
Description	Matches pools that allocate by most cost.
Parameters	`boolean`	`match`	`true` to match pool allocators that allocate by most cost, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearAllocatesByMostCostTerms
Description	Clears the allocate by least cost query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRuledPoolId
Description	Matches mapped to the pool.
Parameters	`osid.id.Id`	`poolId`	the pool `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`poolId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledPoolIdTerms
Description	Clears the pool `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledPoolQuery
Description	Tests if a `PoolQuery` is available.
Return	`boolean`		`true` if a pool query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledPoolQuery
Description	Gets the query for a pool. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.PoolQuery`		the pool query
Errors	UNIMPLEMENTED		`supportsRuledPoolQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledPoolQuery()` is `true`.
Method	matchAnyRuledPool
Description	Matches mapped to any pool.
Parameters	`boolean`	`match`	`true` for mapped to any pool, `false` to match mapped to no pool
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledPoolTerms
Description	Clears the pool query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDistributorId
Description	Matches 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	getPoolProcessorQueryRecord
Description	Gets the pool processor query record corresponding to the given `PoolProcessor` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`poolProcessorRecordType`	a pool processor record type
Return	`osid.provisioning.rules.records.PoolProcessorQueryRecord`		the pool processor query record
Errors	NULL_ARGUMENT		`poolProcessorRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(poolProcessorRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.