OSID - osid.provisioning.RequestQuery Service Interface Definition

Interface	osid.provisioning.RequestQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.provisioning.ProvisionQuery`
	`osid.provisioning.QueueQuery`
	`osid.provisioning.RequestQuerySession`
	`osid.provisioning.RequestSearchSession`
	`osid.provisioning.RequestSmartDistributorSession`
	`osid.provisioning.RequestTransactionQuery`
Description	This is the query for searching requests. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRequestTransactionId
Description	Sets the request transaction `Id` for this query.
Parameters	`osid.id.Id`	`transactionId`	the request transaction `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`transactionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequestTransactionIdTerms
Description	Clears the request transaction `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequestTransactionQuery
Description	Tests if a `RequestTransactionQuery` is available.
Return	`boolean`		`true` if a request transaction query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionQuery
Description	Gets the query for a request transaction. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.RequestTransactionQuery`		the request transaction query
Errors	UNIMPLEMENTED		`supportsRequestTransactionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequestTransactionQuery()` is `true`.
Method	clearRequestTransactionTerms
Description	Clears the request transaction 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	clearQueueTerms
Description	Clears the queue query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRequestDate
Description	Matches requests with a 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	clearRequestDateTerms
Description	Clears the request date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRequesterId
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	clearRequesterIdTerms
Description	Clears the resource `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequesterQuery
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	getRequesterQuery
Description	Gets the query for a resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsRequesterQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequesterQuery()` is `true`.
Method	clearRequesterTerms
Description	Clears the resource query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRequestingAgentId
Description	Sets the agent `Id` for this query.
Parameters	`osid.id.Id`	`agentId`	the agent `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequestingAgentIdTerms
Description	Clears the agent `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequestingAgentQuery
Description	Tests if an `AgentQuery` is available.
Return	`boolean`		`true` if an agent query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRequestingAgentQuery
Description	Gets the query for an agent. Multiple retrievals produce a nested `OR` term.
Return	`osid.authentication.AgentQuery`		the agent query
Errors	UNIMPLEMENTED		`supportsRequestingAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequestingAgentQuery()` is `true`.
Method	clearRequestingAgentTerms
Description	Clears the agent 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 `supportsResourceQuery()` is `true`.
Method	matchAnyPool
Description	Matches requests with any pool.
Parameters	`boolean`	`match`	`true` to match requests with any poo, `false` to match requests 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	matchRequestedProvisionableId
Description	Sets the requested 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	clearRequestedProvisionableIdTerms
Description	Clears the requested provisionable `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequestedProvisionableQuery
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	getRequestedProvisionableQuery
Description	Gets the query for a requested provisionable. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.ProvisionableQuery`		the provisionable query
Errors	UNIMPLEMENTED		`supportsRequestedprovisionableQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequestedProvisionableQuery()` is `true`.
Method	matchAnyRequestedProvisionable
Description	Matches requests with any requested provisionable.
Parameters	`boolean`	`match`	`true` to match requests with any requested provisionable, `false` to match requests with no requested provisionables
Compliance	`mandatory`		This method must be implemented.
Method	clearRequestedProvisionableTerms
Description	Clears the requested provisionable query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchExchangeProvisionId
Description	Sets the exchange provision `Id` for this query.
Parameters	`osid.id.Id`	`provisionId`	the provision `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`provisionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearExchangeProvisionIdTerms
Description	Clears the exchange provision `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsExchangeProvisionQuery
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	getExchangeProvisionQuery
Description	Gets the query for an exchange provision. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.ProvisionQuery`		the provision query
Errors	UNIMPLEMENTED		`supportsExchangeProvisionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsExchangeProvisionQuery()` is `true`.
Method	matchAnyExchangeProvision
Description	Matches requests with any exchange provision.
Parameters	`boolean`	`match`	`true` to match requests with any exchange provision, `false` to match requests with no exchange provision
Compliance	`mandatory`		This method must be implemented.
Method	clearExchangeProvisionTerms
Description	Clears the exchange provision query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOriginProvisionId
Description	Sets the origin provision `Id` for this query.
Parameters	`osid.id.Id`	`provisionId`	the provision `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`provisionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearOriginProvisionIdTerms
Description	Clears the origin provision `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOriginProvisionQuery
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	getOriginProvisionQuery
Description	Gets the query for an origin provision. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.ProvisionQuery`		the provision query
Errors	UNIMPLEMENTED		`supportsOriginProvisionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOriginProvisionQuery()` is `true`.
Method	matchAnyOriginProvision
Description	Matches requests with any originating provision.
Parameters	`boolean`	`match`	`true` to match requests with any originating provision, `false` to match requests with no origininating provision
Compliance	`mandatory`		This method must be implemented.
Method	clearOriginProvisionTerms
Description	Clears the origin provision query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPosition
Description	Matches requests whose position is in the given range inclusive,.
Parameters	`integer`	`start`	start of range
	`integer`	`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	matchAnyPosition
Description	Matches requests with any position.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearPositionTerms
Description	Clears the position query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEWA
Description	Matches requests whose estimated waiting time is in the given range inclusive,.
Parameters	`osid.calendaring.Duration`	`start`	start of range
	`osid.calendaring.Duration`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyEWA
Description	Matches requests with any ewa.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearEWATerms
Description	Clears the ewa query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDistributorId
Description	Sets the distributor `Id` for this query.
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		`supportDistributorQuery()` 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	getRequestQueryRecord
Description	Gets the request query record corresponding to the given `Request` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`requestRecordType`	a request record type
Return	`osid.provisioning.records.RequestQueryRecord`		the request query record
Errors	NULL_ARGUMENT		`requestRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(requestRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.