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

Interface	osid.provisioning.rules.QueueConstrainerEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.provisioning.rules.QueueConstrainerEnablerQuerySession`
	`osid.provisioning.rules.QueueConstrainerEnablerSearchSession`
	`osid.provisioning.rules.QueueConstrainerEnablerSmartDistributorSession`
Description	This is the query for searching queue constrainer enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledQueueConstrainerId
Description	Matches enablers mapped to the queue constrainer.
Parameters	`osid.id.Id`	`queueConstrainerId`	the queue constrainer `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`queueConstrainerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledQueueConstrainerIdTerms
Description	Clears the queue constrainer `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledQueueConstrainerQuery
Description	Tests if a `QueueConstrainerQuery` is available.
Return	`boolean`		`true` if a queue constrainer query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledQueueConstrainerQuery
Description	Gets the query for a queue constrainer. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.rules.QueueConstrainerQuery`		the queue constrainer query
Errors	UNIMPLEMENTED		`supportsRuledQueueConstrainerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledQueueConstrainerQuery()` is `true`.
Method	matchAnyRuledQueueConstrainer
Description	Matches enablers mapped to any queue constrainer.
Parameters	`boolean`	`match`	`true` for enablers mapped to any queue constrainer, `false` to match enablers mapped to no queue constrainers
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledQueueConstrainerTerms
Description	Clears the queue constrainer query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDistributorId
Description	Sets the distributor `Id` for this query to match queues 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	getQueueConstrainerEnablerQueryRecord
Description	Gets the queue constrainer enabler query record corresponding to the given `QueueConstrainerEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`queueConstrainerEnablerRecordType`	a queue constrainer enabler record type
Return	`osid.provisioning.rules.records.QueueConstrainerEnablerQueryRecord`		the queue constrainer enabler query record
Errors	NULL_ARGUMENT		`queueConstrainerEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(queueConstrainerEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.