OSID - osid.OsidRequestQuery Service Interface Definition

Interface	osid.OsidRequestQuery
Implements	`osid.OsidObjectQuery`
Implemented By	`osid.course.registration.request.RegistrationRequestQuery`
Description	This is the query interface for searching requests. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchPostingDate
Description	Matches requests whose posting date falls in between the given dates inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start of date range
	`osid.calendaring.DateTime`	`end`	end of date range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is less than `end`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyPostingDate
Description	Matches requests with any posting date set.
Parameters	`boolean`	`match`	`true` to match any posting date, `false` to match no posting date
Compliance	`mandatory`		This method must be implemented.
Method	clearPostingDateTerms
Description	Clears the posting date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRequesterId
Description	Match the `Id` of the requester.
Parameters	`osid.id.Id`	`resourceId`	`Id` to match
Parameters	`boolean`	`match`	`true` if 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 all requester `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequesterQuery
Description	Tests if a `ResourceQuery` for the requester 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 the resource. Each retrieval performs a boolean `OR`.
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsRequesterQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequesterQuery()` is `true`.
Method	matchAnyRequester
Description	Match any requester.
Parameters	`boolean`	`match`	`true` to match any requester, `false` to match no requesters
Compliance	`mandatory`		This method must be implemented.
Method	clearRequesterTerms
Description	Clears all requsster terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSubmitted
Description	Matches submitted requests.
Parameters	`boolean`	`match`	`true` to match submitted requests, `false` to match unsubmitted requests
Compliance	`mandatory`		This method must be implemented.
Method	clearSubmittedTerms
Description	Clears the submitted query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSubmittedDate
Description	Matches requests whose submitted date falls in between the given dates inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start of date range
	`osid.calendaring.DateTime`	`end`	end of date range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is less than `end`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnySubmittedDate
Description	Matches requests with any submitted date set.
Parameters	`boolean`	`match`	`true` to match any submitted date, `false` to match no submitted date
Compliance	`mandatory`		This method must be implemented.
Method	clearSubmittedDateTerms
Description	Clears the submitted date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSubmitterId
Description	Match the `Id` of the submitter.
Parameters	`osid.id.Id`	`resourceId`	`Id` to match
Parameters	`boolean`	`match`	`true` if 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 all submitter `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubmitterQuery
Description	Tests if a `ResourceQuery` for the submitter 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 the resource. Each retrieval performs a boolean `OR`.
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsSubmitterQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubmitterQuery()` is `true`.
Method	matchAnySubmitter
Description	Match any submitter.
Parameters	`boolean`	`match`	`true` to match any submitter, `false` to match no submitters
Compliance	`mandatory`		This method must be implemented.
Method	clearSubmitterTerms
Description	Clears all submitter terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSubmittingAgentId
Description	Match the `Id` of the submitting agent.
Parameters	`osid.id.Id`	`agentId`	`Id` to match
Parameters	`boolean`	`match`	`true` if 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 all submitting agent `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubmittingAgentQuery
Description	Tests if an `AgentQuery` for the submitter 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 the submitting agent. Each retrieval performs a boolean `OR`.
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Return	`osid.authentication.AgentQuery`		the agent query
Errors	UNIMPLEMENTED		`supportsSubmittingAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubmittingAgentQuery()` is `true`.
Method	matchAnySubmittingAgent
Description	Match any submitting agent.
Parameters	`boolean`	`match`	`true` to match any submitting agent, `false` to match no submitting agents
Compliance	`mandatory`		This method must be implemented.
Method	clearSubmittingAgentTerms
Description	Clears all submitting agent terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCanceled
Description	Matches canceled requests.
Parameters	`boolean`	`match`	`true` to match canceled requests, `false` to match not canceled requests
Compliance	`mandatory`		This method must be implemented.
Method	clearCanceledTerms
Description	Clears the canceled query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProcessedDate
Description	Matches requests whose processed date falls in between the given dates inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start of date range
	`osid.calendaring.DateTime`	`end`	end of date range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is less than `end`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyProcessedDate
Description	Matches requests with any processed date set.
Parameters	`boolean`	`match`	`true` to match any processed date, `false` to match no processed date
Compliance	`mandatory`		This method must be implemented.
Method	clearProcessedDateTerms
Description	Clears the processed date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchErrorId
Description	Match the `Id` of the error state.
Parameters	`osid.id.Id`	`stateId`	`Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`stateId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearErrorIdTerms
Description	Clears all error state `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsErrorQuery
Description	Tests if a `StateQuery` for the submitter is available.
Return	`boolean`		`true` if a state query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getErrorQuery
Description	Gets the query for the state. Each retrieval performs a boolean `OR`.
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Return	`osid.process.StateQuery`		the state query
Errors	UNIMPLEMENTED		`supportsErrorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsErrorQuery()` is `true`.
Method	matchAnyError
Description	Match any error state.
Parameters	`boolean`	`match`	`true` to match any error, `false` to match no requests with no errors
Compliance	`mandatory`		This method must be implemented.
Method	clearErrorTerms
Description	Clears all error terms.
Compliance	`mandatory`		This method must be implemented.