OSID - osid.provisioning.PoolQuery Service Interface Definition

Interface	osid.provisioning.PoolQuery
Implements	`osid.OsidGovernatorQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.provisioning.BrokerQuery`
	`osid.provisioning.DistributorQuery`
	`osid.provisioning.PoolQuerySession`
	`osid.provisioning.PoolSearchSession`
	`osid.provisioning.PoolSmartDistributorSession`
	`osid.provisioning.ProvisionableQuery`
	`osid.provisioning.RequestQuery`
	`osid.provisioning.rules.PoolConstrainerQuery`
	`osid.provisioning.rules.PoolEnablerQuery`
	`osid.provisioning.rules.PoolEnablerSmartDistributorSession`
	show 2 more…
`osid.provisioning.rules.PoolProcessorQuery`
`osid.provisioning.rules.QueueConstrainerQuery`
Description	This is the query for searching pools. 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	matchSupplierId
Description	Sets the supplier `Id` for this query.
Parameters	`osid.id.Id`	`supplierId`	the supplier `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`supplierId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSupplierIdTerms
Description	Clears the supplier `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSupplierQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a supplier query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSupplierQuery
Description	Gets the query for a supplier. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the supplier query
Errors	UNIMPLEMENTED		`supportsSupplierQuery()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnySupplier
Description	Matches pools that have any supplier.
Parameters	`boolean`	`match`	`true` to match pools with any supplier, `false` to match pools with no supplier
Compliance	`mandatory`		This method must be implemented.
Method	clearSupplierTerms
Description	Clears the supplier query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProvisionableId
Description	Sets the provisionable `Id` for this query.
Parameters	`osid.id.Id`	`provisionableId`	the provisionable `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`provisionableId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProvisionableIdTerms
Description	Clears the provisionable `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProvisionableQuery
Description	Tests if a `ProvisionableQuery` is available.
Return	`boolean`		`true` if a provisionable query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionableQuery
Description	Gets the query for a `PoolQntry`. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.ProvisionableQuery`		the provisionable query
Errors	UNIMPLEMENTED		`supportsProvisionableQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProvisionableQuery()` is `true`.
Method	matchAnyProvisionable
Description	Matches pools that have any provisionable.
Parameters	`boolean`	`match`	`true` to match pools with any provisionable, `false` to match pools with no provisionable
Compliance	`mandatory`		This method must be implemented.
Method	clearProvisionableTerms
Description	Clears the provisionable query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSize
Description	Matches pools 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 pools 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	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	getPoolQueryRecord
Description	Gets the pool query record corresponding to the given `Pool` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`poolRecordType`	a pool record type
Return	`osid.provisioning.records.PoolQueryRecord`		the pool query record
Errors	NULL_ARGUMENT		`poolRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(poolRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.