OSID - osid.provisioning.BrokerQuery Service Interface Definition

Interface	osid.provisioning.BrokerQuery
Implements	`osid.OsidGovernatorQuery`
Description	This is the query for searching brokers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchQueueId
Description	Sets the queue `Id` for this query.
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	clearQueueIdTerms
Description	Clears the queue `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsQueueQuery
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	getQueueQuery
Description	Gets the query for a queue. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.QueueQuery`		the queue query
Errors	UNIMPLEMENTED		`supportsQueueQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsQueueQuery()` is `true.`
Method	matchAnyQueue
Description	Matches brokers with any queue.
Parameters	`boolean`	`match`	`true` to match brokers with any queue, `false` to match brokers with no queue
Compliance	`mandatory`		This method must be implemented.
Method	clearQueueTerms
Description	Clears the queue query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPoolId
Description	Sets the pool `Id` for this query.
Parameters	`osid.id.Id`	`poolId`	the pool `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`poolId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPoolIdTerms
Description	Clears the pool `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPoolQuery
Description	Tests if a `PoolQuery` is available.
Return	`boolean`		`true` if a pool query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPoolQuery
Description	Gets the query for a pool. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.PoolQuery`		the pool query
Errors	UNIMPLEMENTED		`supportsPoolQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPoolQuery()` is `true.`
Method	matchAnyPool
Description	Matches brokers with any pool.
Parameters	`boolean`	`match`	`true` to match brokers with any pool, `false` to match brokers with no pool
Compliance	`mandatory`		This method must be implemented.
Method	clearPoolTerms
Description	Clears the pool 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	getBrokerQueryRecord
Description	Gets the broker query record corresponding to the given `Broker` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`brokerRecordType`	a broker record type
Return	`osid.provisioning.records.BrokerQueryRecord`		the broker query record
Errors	NULL_ARGUMENT		`brokerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(brokerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.