OSID - osid.provisioning.RequestTransactionQuery Service Interface Definition

Interface	osid.provisioning.RequestTransactionQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.provisioning.RequestQuery`
	`osid.provisioning.RequestTransactionQuerySession`
	`osid.provisioning.RequestTransactionSearchSession`
	`osid.provisioning.RequestTransactionSmartDistributorSession`
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	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	matchSubmitDate
Description	Matches transactions with a submit 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	clearSubmitDateTerms
Description	Clears the submit date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSubmitterId
Description	Sets the submitter `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	clearSubmitterIdTerms
Description	Clears the submitter `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubmitterQuery
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	getSubmitterQuery
Description	Gets the query for a submitter. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsSubmitterQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubmitterQuery()` is `true` .
Method	clearSubmitterTerms
Description	Clears the submitter query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSubmittingAgentId
Description	Sets the submitting 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	clearSubmittingAgentIdTerms
Description	Clears the submitting agent `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubmittingAgentQuery
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	getSubmittingAgentQuery
Description	Gets the query for a submitting agent. Multiple retrievals produce a nested `OR` term.
Return	`osid.authentication.AgentQuery`		the agent query
Errors	UNIMPLEMENTED		`supportsSubmittingAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubmittingAgentQuery()` is `true` .
Method	clearSubmittingAgentTerms
Description	Clears the submitting agent 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 transactions with any request.
Parameters	`boolean`	`match`	`true` for to match transactions with any request, match, `false` to match transaction 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	getRequestTransactionQueryRecord
Description	Gets the request transaction query record corresponding to the given `Requesttrsnaction` record `Type` . Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`requesttransactionRecordType`	a request transaction record type
Return	`osid.provisioning.records.RequestTransactionQueryRecord`		the request transaction query record
Errors	NULL_ARGUMENT		`requestTransactionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(requestTransactionRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.