OSID - osid.provisioning.QueueQuery Service Interface Definition

Interface	osid.provisioning.QueueQuery
Implements	`osid.OsidGovernatorQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.provisioning.BrokerQuery`
	`osid.provisioning.DistributorQuery`
	`osid.provisioning.QueueQuerySession`
	`osid.provisioning.QueueSearchSession`
	`osid.provisioning.QueueSmartDistributorSession`
	`osid.provisioning.RequestQuery`
	`osid.provisioning.rules.QueueConstrainerQuery`
	`osid.provisioning.rules.QueueEnablerQuery`
	`osid.provisioning.rules.QueueEnablerSmartDistributorSession`
	`osid.provisioning.rules.QueueProcessorQuery`
Description	This is the query for searching queues. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchBrokerId
Description	Sets the broker `Id` for this query.
Parameters	`osid.id.Id`	`brokerId`	the broker `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`brokerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBrokerIdTerms
Description	Clears the broker `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBrokerQuery
Description	Tests if a `BrokerQuery` is available.
Return	`boolean`		`true` if a broker query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerQuery
Description	Gets the query for a broker. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.BrokerQuery`		the broker query
Errors	UNIMPLEMENTED		`supportsBrokerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBrokerQuery()` is `true` .
Method	clearBrokerTerms
Description	Clears the broker query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchManagerId
Description	Sets the manager `Id` for this query.
Parameters	`osid.id.Id`	`managerId`	the manager `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`managerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearManagerIdTerms
Description	Clears the manager `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsManagerQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a manager query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getManagerQuery
Description	Gets the query for a manager. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the manager query
Errors	UNIMPLEMENTED		`supportsManagerQuery()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyManager
Description	Matches queues that have any manager.
Parameters	`boolean`	`match`	`true` to match queues with any manager, `false` to match queues with no manager
Compliance	`mandatory`		This method must be implemented.
Method	clearManagerTerms
Description	Clears the manager query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSize
Description	Matches queues of the given size inclusive.
Parameters	`cardinal`	`start`	start of range
	`cardinal`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnySize
Description	Matches queues with any known size.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearSizeTerms
Description	Clears the size query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEWA
Description	Matches queues whose estimated waiting time is in the given range inclusive,.
Parameters	`osid.calendaring.Duration`	`start`	start of range
	`osid.calendaring.Duration`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyEWA
Description	Matches queues with any estimated wiating time.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearEWATerms
Description	Clears the estimated waiting time query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCanSpecifyProvisionable
Description	Matches queues that permit requests for specific provisionables.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearCanSpecifyProvisionableTerms
Description	Clears the can request provisionables terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRequestId
Description	Sets the request `Id` for this query.
Parameters	`osid.id.Id`	`requestId`	the request `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`requestId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequestIdTerms
Description	Clears the request `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequestQuery
Description	Tests if a `RequestQuery` is available.
Return	`boolean`		`true` if a request query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRequestQuery
Description	Gets the query for a `Request` . Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.RequestQuery`		the request query
Errors	UNIMPLEMENTED		`supportsRequestQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequestQuery()` is `true` .
Method	matchAnyRequest
Description	Matches queues that have any request.
Parameters	`boolean`	`match`	`true` to match queues with any request, `false` to match queues with no request
Compliance	`mandatory`		This method must be implemented.
Method	clearRequestTerms
Description	Clears the request 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	getQueueQueryRecord
Description	Gets the queue query record corresponding to the given `Queue` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`queueRecordType`	a queue record type
Return	`osid.provisioning.records.QueueQueryRecord`		the queue query record
Errors	NULL_ARGUMENT		`queueRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(queueRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.