OSID - osid.provisioning.ProvisionableQuery Service Interface Definition

Interface	osid.provisioning.ProvisionableQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.provisioning.PoolQuery`
	`osid.provisioning.ProvisionQuery`
	`osid.provisioning.ProvisionableQuerySession`
	`osid.provisioning.ProvisionableSearchSession`
	`osid.provisioning.ProvisionableSmartDistributorSession`
	`osid.provisioning.RequestQuery`
	`osid.provisioning.rules.ProvisionableEnablerQuery`
	`osid.provisioning.rules.ProvisionableEnablerSmartDistributorSession`
Description	This is the query for searching provisionables. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
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	clearPoolTerms
Description	Clears the pool query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchResourceId
Description	Sets the resource `Id` for this query.
Parameters	`osid.id.Id`	`resourceId`	the resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearResourceIdTerms
Description	Clears the resource `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceQuery
Description	Gets the query for a resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceQuery()` is `true`.
Method	clearResourceTerms
Description	Clears the resource query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchUse
Description	Matches provisionables provisioned the number of times in the given range 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	clearUseTerms
Description	Clears the position 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 broker `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	getProvisionableQueryRecord
Description	Gets the query record corresponding to the given `Provisionable` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`provisionableRecordType`	a provisionable record type
Return	`osid.provisioning.records.ProvisionableQueryRecord`		the provisionable query record
Errors	NULL_ARGUMENT		`provisionableRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(provisionableRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.