OSID - osid.provisioning.ProvisionReturnQuery Service Interface Definition

Interface	osid.provisioning.ProvisionReturnQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Description	This is the query for searching provision returns. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchReturnDate
Description	Matches provisions with a return 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	clearReturnDateTerms
Description	Clears the return date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchReturnerId
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	clearReturnerIdTerms
Description	Clears the resource `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsReturnerQuery
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	getReturnerQuery
Description	Gets the query for a resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsReturnerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsReturnerQuery()` is `true.`
Method	clearReturnerTerms
Description	Clears the resource query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchReturningAgentId
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	clearReturningAgentIdTerms
Description	Clears the agent `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsReturningAgentQuery
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	getReturningAgentQuery
Description	Gets the query for an agent. Multiple retrievals produce a nested `OR` term.
Return	`osid.authentication.AgentQuery`		the agent query
Errors	UNIMPLEMENTED		`supportsReturningAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsReturningAgentQuery()` is `true.`
Method	clearReturningAgentTerms
Description	Clears the agent query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionReturnQueryRecord
Description	Gets the provision return query record corresponding to the given `ProvisionReturn` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`provisionReturnRecordType`	a provision return record type
Return	`osid.provisioning.records.ProvisionReturnQueryRecord`		the provision return query record
Errors	NULL_ARGUMENT		`provisionReturnRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(provisionReturnRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.