OSID - osid.provisioning.DistributorQuery Service Interface Definition

Interface	osid.provisioning.DistributorQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching distributors. 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 an `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	matchAnyBroker
Description	Matches distributors with any broker.
Parameters	`boolean`	`match`	`true` to match distributors with any broker, `false` to match distributors with no broker
Compliance	`mandatory`		This method must be implemented.
Method	clearBrokerTerms
Description	Clears the broker query terms.
Compliance	`mandatory`		This method must be implemented.
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 distributors with any queue.
Parameters	`boolean`	`match`	`true` to match distributors with any queue, `false` to match distributors 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 distributors with any pool, `false` to match distributors 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	matchProvisionId
Description	Sets the provision `Id` for this query to match distributors that have a related provision.
Parameters	`osid.id.Id`	`provisionId`	a provision `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`provisionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProvisionIdTerms
Description	Clears the provision `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProvisionQuery
Description	Tests if a `ProvisionQuery` is available.
Return	`boolean`		`true` if a provision query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionQuery
Description	Gets the query for a provision. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.ProvisionQuery`		the provision query
Errors	UNIMPLEMENTED		`supportsProvisionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProvisionQuery()` is `true.`
Method	matchAnyProvision
Description	Matches distributors that have any provision.
Parameters	`boolean`	`match`	`true` to match distributors with any provision, `false` to match distributors with no provision
Compliance	`mandatory`		This method must be implemented.
Method	clearProvisionTerms
Description	Clears the provision query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorDistributorId
Description	Sets the distributor `Id` for this query to match distributors that have the specified distributor as an ancestor.
Parameters	`osid.id.Id`	`distributorId`	a distributor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`distributorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorDistributorIdTerms
Description	Clears the ancestor distributor `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorDistributorQuery
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	getAncestorDistributorQuery
Description	Gets the query for a distributor. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.DistributorQuery`		the distributor query
Errors	UNIMPLEMENTED		`supportsAncestorDistributorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorDistributorQuery()` is `true.`
Method	matchAnyAncestorDistributor
Description	Matches distributors with any ancestor.
Parameters	`boolean`	`match`	`true` to match distributors with any ancestor, `false` to match root distributors
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorDistributorTerms
Description	Clears the ancestor distributor query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantDistributorId
Description	Sets the distributor `Id` for this query to match distributors that have the specified distributor as a descendant.
Parameters	`osid.id.Id`	`distributorId`	a distributor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`distributorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantDistributorIdTerms
Description	Clears the descendant distributor `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantDistributorQuery
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	getDescendantDistributorQuery
Description	Gets the query for a distributor/ Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.DistributorQuery`		the distributor query
Errors	UNIMPLEMENTED		`supportsDescendantDistributorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantDistributorQuery()` is `true.`
Method	matchAnyDescendantDistributor
Description	Matches distributors with any descendant.
Parameters	`boolean`	`match`	`true` to match distributors with any descendant, `false` to match leaf distributors
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantDistributorTerms
Description	Clears the descendant distributor query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getDistributorQueryRecord
Description	Gets the distributor query record corresponding to the given `Distributor` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`distributorRecordType`	a distributor record type
Return	`osid.provisioning.records.DistributorQueryRecord`		the distributor query record
Errors	NULL_ARGUMENT		`distributorRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(distributorRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.