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

Interface	osid.provisioning.rules.PoolProcessorQueryInspector
Implements	`osid.OsidProcessorQueryInspector`
Used By	`osid.provisioning.rules.PoolProcessorEnablerQueryInspector`
	`osid.provisioning.rules.PoolProcessorSearchResults`
	`osid.provisioning.rules.PoolProcessorSmartDistributorSession`
Description	This is the query inspector for examining pool processor queries. Like all `OsidQueryInspectors`, `PoolProcessorQueryInspector` is stateful and must not be accessed by multiple processing threads.
Method	getAllocatesByLeastUseTerms
Description	Gets the allocates by least use query terms.
Return	`osid.search.terms.BooleanTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getAllocatesByMostUseTerms
Description	Gets the allocates by most use query terms.
Return	`osid.search.terms.BooleanTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getAllocatesByLeastCostTerms
Description	Gets the allocates by least cost query terms.
Return	`osid.search.terms.BooleanTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getAllocatesByMostCostTerms
Description	Gets the allocates by most cost query terms.
Return	`osid.search.terms.BooleanTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getRuledPoolIdTerms
Description	Gets the pool `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getRuledPoolTerms
Description	Gets the pool query terms.
Return	`osid.provisioning.PoolQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getDistributorIdTerms
Description	Gets the distributor `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getDistributorTerms
Description	Gets the distributor query terms.
Return	`osid.provisioning.DistributorQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorQueryInspectorRecord
Description	Gets the pool processor query inspector record corresponding to the given `PoolProcessor` record `Type`.
Parameters	`osid.type.Type`	`poolProcessorRecordType`	a pool processor record type
Return	`osid.provisioning.rules.records.PoolProcessorQueryInspectorRecord`		the pool processor query inspector 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.