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

Interface	osid.provisioning.rules.PoolConstrainerQuery
Implements	`osid.OsidConstrainerQuery`
Used By	`osid.provisioning.rules.PoolConstrainerEnablerQuery`
	`osid.provisioning.rules.PoolConstrainerQuerySession`
	`osid.provisioning.rules.PoolConstrainerSearchSession`
	`osid.provisioning.rules.PoolConstrainerSmartDistributorSession`
Description	This is the query for searching pool constrainers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
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	Sets the distributor `Id` for this query to match pools assigned to distributors.
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	getPoolConstrainerQueryRecord
Description	Gets the pool constrainer query record corresponding to the given `PoolConstrainer` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`poolConstrainerRecordType`	a pool constrainer record type
Return	`osid.provisioning.rules.records.PoolConstrainerQueryRecord`		the pool constrainer query record
Errors	NULL_ARGUMENT		`poolConstrainerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(poolConstrainerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.