Interface ResponseQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

public interface ResponseQuery
extends OsidRelationshipQuery

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.

Like all OsidQueries, ResponseQuery is stateful and must not be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
void	clearAffirmativeTerms()	Clears the affirmative query terms.
void	clearInquestIdTerms()	Clears the inquest Id query terms.
void	clearInquestTerms()	Clears the inquest query terms.
void	clearInquiryIdTerms()	Clears the inquiry Id query terms.
void	clearInquiryTerms()	Clears the inquiry query terms.
void	clearResponderIdTerms()	Clears the responder resource Id query terms.
void	clearResponderTerms()	Clears the responder resource query terms.
void	clearRespondingAgentIdTerms()	Clears the responding agent Id query terms.
void	clearRespondingAgentTerms()	Clears the responding agent query terms.
InquestQuery	getInquestQuery()	Gets the query for an inquest.
InquiryQuery	getInquiryQuery()	Gets the query for an inquiry.
ResourceQuery	getResponderQuery()	Gets the query for a responder resource.
AgentQuery	getRespondingAgentQuery()	Gets the query for a responding agent.
ResponseQueryRecord	getResponseQueryRecord(Type responseRecordType)	Gets the query record corresponding to the given Response record Type.Multiple record retrievals produce a nested OR term.
void	matchAffirmative(boolean match)	Matches affirmative responses.
void	matchInquestId(Id inquestId, boolean match)	Sets the inquest Id for this query to match audits assigned to inquests.
void	matchInquiryId(Id inquiryId, boolean match)	Sets the inquiry Id for this query.
void	matchResponderId(Id resourceId, boolean match)	Sets the responder resource Id for this query.
void	matchRespondingAgentId(Id agentId, boolean match)	Sets the responding agent Id for this query.
boolean	supportsInquestQuery()	Tests if an InquestQuery is available.
boolean	supportsInquiryQuery()	Tests if an InquiryQuery is available.
boolean	supportsResponderQuery()	Tests if a ResourceQuery is available.
boolean	supportsRespondingAgentQuery()	Tests if an AgentQuery is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Methods inherited from interface OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Details

matchInquiryId

void matchInquiryId(Id inquiryId,
 boolean match)

Sets the inquiry Id for this query.

Parameters:

inquiryId - the inquiry Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - inquiryId is null

Compliance:

mandatory - This method must be implemented.

clearInquiryIdTerms

void clearInquiryIdTerms()

Clears the inquiry Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsInquiryQuery

boolean supportsInquiryQuery()

Tests if an InquiryQuery is available.

Returns:

true if an inquiry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getInquiryQuery

InquiryQuery getInquiryQuery()

Gets the query for an inquiry. Multiple retrievals produce a nested OR term.

Returns:

the inquiry query

Throws:

UnimplementedException - supportsInquiryQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsInquiryQuery()} is {@code true}.

clearInquiryTerms

void clearInquiryTerms()

Clears the inquiry query terms.

Compliance:

mandatory - This method must be implemented.

matchResponderId

void matchResponderId(Id resourceId,
 boolean match)

Sets the responder resource Id for this query.

Parameters:

resourceId - the resource Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearResponderIdTerms

void clearResponderIdTerms()

Clears the responder resource Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsResponderQuery

boolean supportsResponderQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResponderQuery

ResourceQuery getResponderQuery()

Gets the query for a responder resource. Multiple retrievals produce a nested OR term.

Returns:

the resource query

Throws:

UnimplementedException - supportsResponderQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsResponderQuery()} is {@code true}.

clearResponderTerms

void clearResponderTerms()

Clears the responder resource query terms.

Compliance:

mandatory - This method must be implemented.

matchRespondingAgentId

void matchRespondingAgentId(Id agentId,
 boolean match)

Sets the responding agent Id for this query.

Parameters:

agentId - the agent Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearRespondingAgentIdTerms

void clearRespondingAgentIdTerms()

Clears the responding agent Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRespondingAgentQuery

boolean supportsRespondingAgentQuery()

Tests if an AgentQuery is available.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRespondingAgentQuery

AgentQuery getRespondingAgentQuery()

Gets the query for a responding agent. Multiple retrievals produce a nested OR term.

Returns:

the agent query

Throws:

UnimplementedException - supportsRespondingAgentQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsRespondingAgentQuery()} is {@code true}.

clearRespondingAgentTerms

void clearRespondingAgentTerms()

Clears the responding agent query terms.

Compliance:

mandatory - This method must be implemented.

matchAffirmative

void matchAffirmative(boolean match)

Matches affirmative responses.

Parameters:

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearAffirmativeTerms

void clearAffirmativeTerms()

Clears the affirmative query terms.

Compliance:

mandatory - This method must be implemented.

matchInquestId

void matchInquestId(Id inquestId,
 boolean match)

Sets the inquest Id for this query to match audits assigned to inquests.

Parameters:

inquestId - the inquest Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - inquestId is null

Compliance:

mandatory - This method must be implemented.

clearInquestIdTerms

void clearInquestIdTerms()

Clears the inquest Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsInquestQuery

boolean supportsInquestQuery()

Tests if an InquestQuery is available.

Returns:

true if an inquest query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getInquestQuery

InquestQuery getInquestQuery()

Gets the query for an inquest. Multiple retrievals produce a nested OR term.

Returns:

the inquest query

Throws:

UnimplementedException - supportsInquestQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsInquestQuery()} is {@code true}.

clearInquestTerms

void clearInquestTerms()

Clears the inquest query terms.

Compliance:

mandatory - This method must be implemented.

getResponseQueryRecord

ResponseQueryRecord getResponseQueryRecord(Type responseRecordType)
                                    throws OperationFailedException

Gets the query record corresponding to the given Response record Type.Multiple record retrievals produce a nested OR term.

Parameters:

responseRecordType - a response record type

Returns:

the response query record

Throws:

NullArgumentException - responseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(responseRecordType) is false

Compliance:

mandatory - This method must be implemented.