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

Interface	osid.provisioning.rules.PoolConstrainerEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.provisioning.rules.PoolConstrainerEnablerQuerySession`
	`osid.provisioning.rules.PoolConstrainerEnablerSearchSession`
	`osid.provisioning.rules.PoolConstrainerEnablerSmartDistributorSession`
Description	This is the query for searching pool constrainer enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledPoolConstrainerId
Description	Matches mapped to the pool constrainer.
Parameters	`osid.id.Id`	`poolConstrainerId`	the pool constrainer `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`poolConstrainerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledPoolConstrainerIdTerms
Description	Clears the pool constrainer `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledPoolConstrainerQuery
Description	Tests if a `PoolConstrainerQuery` is available.
Return	`boolean`		`true` if a pool constrainer query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledPoolConstrainerQuery
Description	Gets the query for a pool constrainer. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.rules.PoolConstrainerQuery`		the pool constrainer rquery
Errors	UNIMPLEMENTED		`supportsRuledPoolConstrainerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledPoolConstrainerQuery()` is `true`.
Method	matchAnyRuledPoolConstrainer
Description	Matches mapped to any pool constrainer.
Parameters	`boolean`	`match`	`true` for mapped to any pool constrainer, `false` to match mapped to no pool constrainer
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledPoolConstrainerTerms
Description	Clears the pool constrainer 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	getPoolConstrainerEnablerQueryRecord
Description	Gets the pool constrainer enabler query record corresponding to the given `PoolConstrainerEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`poolConstrainerEnablerRecordType`	a pool constrainer enabler record type
Return	`osid.provisioning.rules.records.PoolConstrainerEnablerQueryRecord`		the pool constrainer enabler query record
Errors	NULL_ARGUMENT		`poolConstrainerEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(poolConstrainerEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.