public interface InquiryQuery extends OsidRuleQuery, OsidSubjugateableQuery
This is the query for searching inquiries. 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 |
clearAffirmationRequiredTerms()
Clears the affirmation required query terms.
|
void |
clearAuditIdTerms()
Clears the audit
Id query terms. |
void |
clearAuditTerms()
Clears the audit query terms.
|
void |
clearInquestIdTerms()
Clears the inquest
Id query terms. |
void |
clearInquestTerms()
Clears the inquest query terms.
|
void |
clearNeedsOneResponseTerms()
Clears the needs one response query terms.
|
void |
clearQuestionTerms()
Clears the question query terms.
|
void |
clearRequiredTerms()
Clears the required query terms.
|
AuditQuery |
getAuditQuery()
Gets the query for an
Audit, Multiple retrievals
produce a nested OR term. |
InquestQuery |
getInquestQuery()
Gets the query for an inquest.
|
InquiryQueryRecord |
getInquiryQueryRecord(Type inquiryRecordType)
Gets the inquiry query record corresponding to the given
Inquiry record Type. |
void |
matchAffirmationRequired(boolean match)
Matches inquiries that require a positive response.
|
void |
matchAnyAffirmationRequired(boolean match)
Matches inquiries with any affirmation required flag set.
|
void |
matchAnyNeedsOneResponse(boolean match)
Matches inquiries with any needs one response set.
|
void |
matchAnyQuestion(boolean match)
Matches inquiries with any question.
|
void |
matchAnyRequired(boolean match)
Matches inquiries with any required flag set.
|
void |
matchAuditId(Id auditId,
boolean match)
Sets the audit
Id for this query. |
void |
matchInquestId(Id inquestId,
boolean match)
Sets the inquest
Id for this query to match inquiries
assigned to inquests. |
void |
matchNeedsOneResponse(boolean match)
Matches inquiries that require a single response.
|
void |
matchQuestion(java.lang.String question,
Type stringMatchType,
boolean match)
Sets the question for this query.
|
void |
matchRequired(boolean match)
Matches inquiries that are required.
|
boolean |
supportsAuditQuery()
Tests if an
AuditQuery is available. |
boolean |
supportsInquestQuery()
Tests if an
InquestQuery is available. |
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
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()
Audit,
Multiple retrievals
produce a nested OR
term.UnimplementedException
- supportsAuditQuery()
is false
optional
- This method must be implemented if
supportAuditQuery()
is true.
void clearAuditTerms()
mandatory
- This method must be implemented. void matchQuestion(java.lang.String question, Type stringMatchType, boolean match)
question
- the questionstringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchNullArgumentException
- question
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyQuestion(boolean match)
match
- true
to match inquiries with a question,
false
to match inquiries with no questionmandatory
- This method must be implemented. void clearQuestionTerms()
mandatory
- This method must be implemented. void matchRequired(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyRequired(boolean match)
match
- true
to match inquiries with a required
flag set, false
to match inquiries with no
required flag setmandatory
- This method must be implemented. void clearRequiredTerms()
mandatory
- This method must be implemented. void matchAffirmationRequired(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyAffirmationRequired(boolean match)
match
- true
to match inquiries with an
affirmation required flag set, false
to match
inquiries with no affirmation required flag setmandatory
- This method must be implemented. void clearAffirmationRequiredTerms()
mandatory
- This method must be implemented. void matchNeedsOneResponse(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyNeedsOneResponse(boolean match)
match
- true
to match inquiries with a need one
response flag set, false
to match inquiries
with no needs one response flag setmandatory
- This method must be implemented. void clearNeedsOneResponseTerms()
mandatory
- This method must be implemented. void matchInquestId(Id inquestId, boolean match)
Id
for this query to match inquiries
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. InquiryQueryRecord getInquiryQueryRecord(Type inquiryRecordType) throws OperationFailedException
Inquiry
record Type.
Multiple record retrievals
produce a nested OR
term.inquiryRecordType
- an inquiry record typeNullArgumentException
- inquiryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(inquiryRecordType)
is false
mandatory
- This method must be implemented.