OSID - osid.provisioning.ProvisionQuery Service Interface Definition

Interface	osid.provisioning.ProvisionQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.provisioning.DistributorQuery`
	`osid.provisioning.ProvisionQuerySession`
	`osid.provisioning.ProvisionSearchSession`
	`osid.provisioning.ProvisionSmartDistributorSession`
	`osid.provisioning.RequestQuery`
	`osid.provisioning.rules.ProvisionEnablerQuery`
	`osid.provisioning.rules.ProvisionEnablerSmartDistributorSession`
Description	This is the query for searching provisions. 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 `supportBrokerQuery()` is `true`.
Method	clearBrokerTerms
Description	Clears the broker 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 `Provisionable`. 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	clearProvisionableTerms
Description	Clears the provisionable query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRecipientId
Description	Sets the recipient `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	clearRecipientIdTerms
Description	Clears the recipient `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRecipientQuery
Description	Tests if a `RecipientQuery` is available.
Return	`boolean`		`true` if a recipient query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRecipientQuery
Description	Gets the query for a `Recipient`. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsRecipientQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRecipientQuery()` is `true`.
Method	clearRecipientTerms
Description	Clears the recipient query 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 provisions with any request.
Parameters	`boolean`	`match`	`true` to match provisions with a request, `false` to match provisions with no requests
Compliance	`mandatory`		This method must be implemented.
Method	clearRequestTerms
Description	Clears the request query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProvisionDate
Description	Matches provisions with a provision date in the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	the range start
	`osid.calendaring.DateTime`	`to`	the range end
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProvisionDateTerms
Description	Clears the provision date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLeased
Description	Matches provisions that are leases.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearLeasedTerms
Description	Clears the leased query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMustReturn
Description	Matches provisions that must be returned.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearMustReturnTerms
Description	Clears the must return query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDueDate
Description	Matches leased provisions with a due date within the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	the range start
	`osid.calendaring.DateTime`	`to`	the range end
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDueDate
Description	Matches provisions with any due date.
Parameters	`boolean`	`match`	`true` to match provisions with a due date, `false` to match provisions with no due date
Compliance	`mandatory`		This method must be implemented.
Method	clearDueDateTerms
Description	Clears the due date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCost
Description	Matches leased provisions with a cost within the given range inclusive.
Parameters	`osid.financials.Currency`	`from`	the range start
	`osid.financials.Currency`	`to`	the range end
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCost
Description	Matches provisions with any cost.
Parameters	`boolean`	`match`	`true` to match provisions with a cost, `false` to match provisions with no cost
Compliance	`mandatory`		This method must be implemented.
Method	clearCostTerms
Description	Clears the cost query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRateAmount
Description	Matches leased provisions with a rate amount within the given range inclusive.
Parameters	`osid.financials.Currency`	`from`	the range start
	`osid.financials.Currency`	`to`	the range end
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyRateAmount
Description	Matches provisions with any rate amount.
Parameters	`boolean`	`match`	`true` to match provisions with a rate, `false` to match provisions with no rate
Compliance	`mandatory`		This method must be implemented.
Method	clearRateAmountTerms
Description	Clears the rate amount query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRatePeriod
Description	Matches leased provisions with a rate period within the given range inclusive.
Parameters	`osid.calendaring.Duration`	`from`	the range start
	`osid.calendaring.Duration`	`to`	the range end
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyRatePeriod
Description	Matches provisions with any rate period.
Parameters	`boolean`	`match`	`true` to match provisions with a rate period, `false` to match provisions with no rate period
Compliance	`mandatory`		This method must be implemented.
Method	clearRatePeriodTerms
Description	Clears the rate period query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProvisionReturnQuery
Description	Tests if a `ProvisionReturn` is available.
Return	`boolean`		`true` if a provision return query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionReturnQuery
Description	Gets the query for a provision return. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.ProvisionReturnQuery`		the provision return query
Errors	UNIMPLEMENTED		`supportsProvisionReturnQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProvisionReturnQuery()` is `true`.
Method	matchAnyProvisionReturn
Description	Matches provisions with any provision return.
Parameters	`boolean`	`match`	`true` to match provisions with a provision return, `false` to match provisions with no provision return
Compliance	`mandatory`		This method must be implemented.
Method	clearProvisionReturnTerms
Description	Clears the provision return query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDistributorId
Description	Sets the distributor `Id` for this query to match provisions 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	getProvisionQueryRecord
Description	Gets the provision query record corresponding to the given `Provision` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`provisionRecordType`	a provision record type
Return	`osid.provisioning.records.ProvisionQueryRecord`		the provision query record
Errors	NULL_ARGUMENT		`provisionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(provisionRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.