public interface InquestQuery extends OsidCatalogQuery
This is the query for searching inquests. 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 |
clearAncestorInquestIdTerms()
Clears the ancestor inquest
Id query terms. |
void |
clearAncestorInquestTerms()
Clears the ancestor inquest query terms.
|
void |
clearAuditIdTerms()
Clears the audit
Id query terms. |
void |
clearAuditTerms()
Clears the audit query terms.
|
void |
clearDescendantInquestIdTerms()
Clears the descendant inquest
Id query terms. |
void |
clearDescendantInquestTerms()
Clears the descendant inquest query terms.
|
void |
clearInquiryIdTerms()
Clears the inquiry
Id query terms. |
void |
clearInquiryTerms()
Clears the inquiry query terms.
|
void |
clearResponseIdTerms()
Clears the response
Id query terms. |
void |
clearResponseTerms()
Clears the response query terms.
|
InquestQuery |
getAncestorInquestQuery()
Gets the query for an inquest.
|
AuditQuery |
getAuditQuery()
Gets the query for an audit.
|
InquestQuery |
getDescendantInquestQuery()
Gets the query for an inquest/ Multiple retrievals produce a nested
OR term. |
InquestQueryRecord |
getInquestQueryRecord(Type inquestRecordType)
Gets the inquest query record corresponding to the given
Inquest record Type. |
InquiryQuery |
getInquiryQuery()
Gets the query for an inquiry.
|
ResponseQuery |
getResponseQuery()
Gets the query for a response.
|
void |
matchAncestorInquestId(Id inquestId,
boolean match)
Sets the inquest
Id for this query to match inquests
that have the specified inquest as an ancestor. |
void |
matchAnyAncestorInquest(boolean match)
Matches inquests with any ancestor.
|
void |
matchAnyAudit(boolean match)
Matches inquests with any audit.
|
void |
matchAnyDescendantInquest(boolean match)
Matches inquests with any descendant.
|
void |
matchAnyInquiry(boolean match)
Matches inquests that have any inquiry.
|
void |
matchAnyResponse(boolean match)
Matches inquests with any response.
|
void |
matchAuditId(Id auditId,
boolean match)
Sets the audit
Id for this query. |
void |
matchDescendantInquestId(Id inquestId,
boolean match)
Sets the inquest
Id for this query to match inquests
that have the specified inquest as a descendant. |
void |
matchInquiryId(Id inquiryId,
boolean match)
Sets the inquiry
Id for this query to match inquests
that have a related response. |
void |
matchResponseId(Id responseId,
boolean match)
Sets the response
Id for this query. |
boolean |
supportsAncestorInquestQuery()
Tests if an
InquestQuery is available. |
boolean |
supportsAuditQuery()
Tests if an
AuditQuery is available. |
boolean |
supportsDescendantInquestQuery()
Tests if an
InquestQuery is available. |
boolean |
supportsInquiryQuery()
Tests if an
InquiryQuery is available. |
boolean |
supportsResponseQuery()
Tests if a
ResponseQuery is available. |
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
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchInquiryId(Id inquiryId, boolean match)
Id
for this query to match inquests
that have a related response.inquiryId
- an inquiry Id
match
- true
if a positive match, false
for 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 matchAnyInquiry(boolean match)
match
- true
to match inquests with any inquiry,
false
to match inquests with no inquirymandatory
- This method must be implemented. void clearInquiryTerms()
mandatory
- This method must be implemented. void matchAuditId(Id auditId, boolean match)
Id
for this query.auditId
- the audit Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- auditId
is
null
mandatory
- This method must be implemented. void clearAuditIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAuditQuery()
AuditQuery
is available. true
if an audit query is available,
false
otherwisemandatory
- This method must be implemented. AuditQuery getAuditQuery()
OR
term.UnimplementedException
- supportsAuditQuery()
is false
optional
- This method must be implemented if
supportsAuditQuery()
is true.
void matchAnyAudit(boolean match)
match
- true
to match inquests with any audit,
false
to match inquests with no auditmandatory
- This method must be implemented. void clearAuditTerms()
mandatory
- This method must be implemented. void matchResponseId(Id responseId, boolean match)
Id
for this query.responseId
- the response Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- responseId
is
null
mandatory
- This method must be implemented. void clearResponseIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsResponseQuery()
ResponseQuery
is available. true
if a response query is available,
false
otherwisemandatory
- This method must be implemented. ResponseQuery getResponseQuery()
OR
term.UnimplementedException
- supportsResponseQuery()
is false
optional
- This method must be implemented if
supportsResponseQuery()
is true.
void matchAnyResponse(boolean match)
match
- true
to match inquests with any response,
false
to match inquests with no responsemandatory
- This method must be implemented. void clearResponseTerms()
mandatory
- This method must be implemented. void matchAncestorInquestId(Id inquestId, boolean match)
Id
for this query to match inquests
that have the specified inquest as an ancestor.inquestId
- an inquest Id
match
- true
for a positive match, false
for negative matchNullArgumentException
- inquestId
is
null
mandatory
- This method must be implemented. void clearAncestorInquestIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorInquestQuery()
InquestQuery
is available. true
if an inquest query is available,
false
otherwisemandatory
- This method must be implemented. InquestQuery getAncestorInquestQuery()
OR
term.UnimplementedException
-
supportsAncestorInquestQuery()
is false
optional
- This method must be implemented if
supportsAncestorInquestQuery()
is true.
void matchAnyAncestorInquest(boolean match)
match
- true
to match inquests with any ancestor,
false
to match root inquestsmandatory
- This method must be implemented. void clearAncestorInquestTerms()
mandatory
- This method must be implemented. void matchDescendantInquestId(Id inquestId, boolean match)
Id
for this query to match inquests
that have the specified inquest as a descendant.inquestId
- an inquest Id
match
- true
for a positive match, false
for negative matchNullArgumentException
- inquestId
is
null
mandatory
- This method must be implemented. void clearDescendantInquestIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantInquestQuery()
InquestQuery
is available. true
if an inquest query is available,
false
otherwisemandatory
- This method must be implemented. InquestQuery getDescendantInquestQuery()
OR
term.UnimplementedException
-
supportsDescendantInquestQuery()
is false
optional
- This method must be implemented if
supportsDescendantInquestQuery()
is true.
void matchAnyDescendantInquest(boolean match)
match
- true
to match inquests with any
descendant, false
to match leaf inquestsmandatory
- This method must be implemented. void clearDescendantInquestTerms()
mandatory
- This method must be implemented. InquestQueryRecord getInquestQueryRecord(Type inquestRecordType) throws OperationFailedException
Inquest
record Type.
Multiple record retrievals
produce a nested OR
term.inquestRecordType
- an inquest record typeNullArgumentException
- inquestRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(inquestRecordType)
is false
mandatory
- This method must be implemented.