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

Interface	osid.provisioning.rules.QueueProcessorEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.provisioning.rules.QueueProcessorEnablerQuerySession`
	`osid.provisioning.rules.QueueProcessorEnablerSearchSession`
	`osid.provisioning.rules.QueueProcessorEnablerSmartDistributorSession`
Description	This is the query for searching queue processor enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchRuledQueueProcessorId
Description	Matches enablers mapped to the queue processor.
Parameters	`osid.id.Id`	`queueProcessorId`	the queue processor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`queueProcessorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledQueueProcessorIdTerms
Description	Clears the queue processor `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledQueueProcessorQuery
Description	Tests if a `QueueProcessorQuery` is available.
Return	`boolean`		`true` if a queue processor query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledQueueProcessorQuery
Description	Gets the query for a queue processor. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.rules.QueueProcessorQuery`		the queue processor query
Errors	UNIMPLEMENTED		`supportsRuledQueueProcessorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledQueueProcessorQuery()` is `true` .
Method	matchAnyRuledQueueProcessor
Description	Matches enablers mapped to any queue processor.
Parameters	`boolean`	`match`	`true` for enablers mapped to any queue processor, `false` to match enablers mapped to no queue processors
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledQueueProcessorTerms
Description	Clears the queue processor 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	getQueueProcessorEnablerQueryRecord
Description	Gets the queue processor enabler query record corresponding to the given `QueueProcessorEnabler` record `Type` . Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`queueProcessorEnablerRecordType`	a queue processor enabler record type
Return	`osid.provisioning.rules.records.QueueProcessorEnablerQueryRecord`		the queue processor enabler query record
Errors	NULL_ARGUMENT		`queueProcessorEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(queueProcessorEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.