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.
Modifier and Type | Method and 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. |
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. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchInquiryId(Id inquiryId, boolean match)
Id
for this query.inquiryId
- the inquiry Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- inquiryId
is
null
mandatory
- This method must be implemented. void clearInquiryIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsInquiryQuery()
InquiryQuery
is available. true
if an inquiry query is available,
false
otherwisemandatory
- This method must be implemented. InquiryQuery getInquiryQuery()
OR
term.UnimplementedException
- supportsInquiryQuery()
is false
optional
- This method must be implemented if
supportsInquiryQuery()
is true.
void clearInquiryTerms()
mandatory
- This method must be implemented. void matchResponderId(Id resourceId, boolean match)
Id
for this query.resourceId
- the resource Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearResponderIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsResponderQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getResponderQuery()
OR
term.UnimplementedException
-
supportsResponderQuery()
is false
optional
- This method must be implemented if
supportsResponderQuery()
is true.
void clearResponderTerms()
mandatory
- This method must be implemented. void matchRespondingAgentId(Id agentId, boolean match)
Id
for this query.agentId
- the agent Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- agentId
is
null
mandatory
- This method must be implemented. void clearRespondingAgentIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRespondingAgentQuery()
AgentQuery
is available. true
if an agent query is available,
false
otherwisemandatory
- This method must be implemented. AgentQuery getRespondingAgentQuery()
OR
term.UnimplementedException
-
supportsRespondingAgentQuery()
is false
optional
- This method must be implemented if
supportsRespondingAgentQuery()
is true.
void clearRespondingAgentTerms()
mandatory
- This method must be implemented. void matchAffirmative(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearAffirmativeTerms()
mandatory
- This method must be implemented. void matchInquestId(Id inquestId, boolean match)
Id
for this query to match audits
assigned to inquests.inquestId
- the inquest Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- inquestId
is
null
mandatory
- This method must be implemented. void clearInquestIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsInquestQuery()
InquestQuery
is available. true
if an inquest query is available,
false
otherwisemandatory
- This method must be implemented. InquestQuery getInquestQuery()
OR
term.UnimplementedException
- supportsInquestQuery()
is false
optional
- This method must be implemented if
supportsInquestQuery()
is true.
void clearInquestTerms()
mandatory
- This method must be implemented. ResponseQueryRecord getResponseQueryRecord(Type responseRecordType) throws OperationFailedException
Response
record Type.
Multiple record retrievals produce
a nested OR
term.responseRecordType
- a response record typeNullArgumentException
- responseRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(responseRecordType)
is false
mandatory
- This method must be implemented.