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

Interface	osid.provisioning.rules.QueueEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.provisioning.rules.QueueEnablerQuerySession`
	`osid.provisioning.rules.QueueEnablerSearchSession`
	`osid.provisioning.rules.QueueEnablerSmartDistributorSession`
Description	This is the query for searching queue enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledQueueId
Description	Matches mapped to a queue.
Parameters	`osid.id.Id`	`queueId`	the queue `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`queueId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledQueueIdTerms
Description	Clears the queue `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledQueueQuery
Description	Tests if a `QueueQuery` is available.
Return	`boolean`		`true` if a queue query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledQueueQuery
Description	Gets the query for a queue. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.QueueQuery`		the queue query
Errors	UNIMPLEMENTED		`supportsRuledQueueQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledQueueQuery()` is `true`.
Method	matchAnyRuledQueue
Description	Matches mapped to any queue.
Parameters	`boolean`	`match`	`true` for mapped to any queue, `false` to match mapped to no queues
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledQueueTerms
Description	Clears the queue 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	getQueueEnablerQueryRecord
Description	Gets the queue enabler query record corresponding to the given `QueueEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`queueEnablerRecordType`	a queue enabler record type
Return	`osid.provisioning.rules.records.QueueEnablerQueryRecord`		the queue enabler query record
Errors	NULL_ARGUMENT		`queueEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(queueEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.