OSID - osid.inquiry.ResponseQuery Service Interface Definition

Interface	osid.inquiry.ResponseQuery
Implements	`osid.OsidRelationshipQuery`
Description	This is the query for searching responses. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchInquiryId
Description	Sets the inquiry `Id` for this query.
Parameters	`osid.id.Id`	`inquiryId`	the inquiry `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`inquiryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearInquiryIdTerms
Description	Clears the inquiry `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquiryQuery
Description	Tests if an `InquiryQuery` is available.
Return	`boolean`		`true` if an inquiry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryQuery
Description	Gets the query for an inquiry. Multiple retrievals produce a nested `OR` term.
Return	`osid.inquiry.InquiryQuery`		the inquiry query
Errors	UNIMPLEMENTED		`supportsInquiryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInquiryQuery()` is `true.`
Method	clearInquiryTerms
Description	Clears the inquiry query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchResponderId
Description	Sets the responder 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	clearResponderIdTerms
Description	Clears the responder resource `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResponderQuery
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	getResponderQuery
Description	Gets the query for a responder resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsResponderQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResponderQuery()` is `true.`
Method	clearResponderTerms
Description	Clears the responder resource query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRespondingAgentId
Description	Sets the responding 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	clearRespondingAgentIdTerms
Description	Clears the responding agent `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRespondingAgentQuery
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	getRespondingAgentQuery
Description	Gets the query for a responding agent. Multiple retrievals produce a nested `OR` term.
Return	`osid.authentication.AgentQuery`		the agent query
Errors	UNIMPLEMENTED		`supportsRespondingAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRespondingAgentQuery()` is `true.`
Method	clearRespondingAgentTerms
Description	Clears the responding agent query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAffirmative
Description	Matches affirmative responses.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearAffirmativeTerms
Description	Clears the affirmative query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchInquestId
Description	Sets the inquest `Id` for this query to match audits assigned to inquests.
Parameters	`osid.id.Id`	`inquestId`	the inquest `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`inquestId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearInquestIdTerms
Description	Clears the inquest `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquestQuery
Description	Tests if an `InquestQuery` is available.
Return	`boolean`		`true` if an inquest query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInquestQuery
Description	Gets the query for an inquest. Multiple retrievals produce a nested `OR` term.
Return	`osid.inquiry.InquestQuery`		the inquest query
Errors	UNIMPLEMENTED		`supportsInquestQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInquestQuery()` is `true.`
Method	clearInquestTerms
Description	Clears the inquest query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getResponseQueryRecord
Description	Gets the query record corresponding to the given `Response` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`responseRecordType`	a response record type
Return	`osid.inquiry.records.ResponseQueryRecord`		the response query record
Errors	NULL_ARGUMENT		`responseRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(responseRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.