Interface InquiryQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, OsidSubjugateableQuery, Suppliable

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 .

Method Summary

Modifier and Type	Method	Description
void	clearAffirmationRequiredTerms()	Clears the affirmation required query terms.
void	clearAuditIdTerms()	Clears the audit Id query terms.
void	clearAuditorIdTerms()	Clears the auditor Id query terms.
void	clearAuditorTerms()	Clears the auditor 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.
ResourceQuery	getAuditorQuery()	Gets the query for a auditor.
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 .Multiple record retrievals produce a nested OR term.
void	matchAffirmationRequired(boolean match)	Matches inquiries that require a positive response.
void	matchAnyAffirmationRequired(boolean match)	Matches inquiries with any affirmation required flag set.
void	matchAnyAuditor(boolean match)	Matches objects with any auditor.
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	matchAuditorId(Id auditorId, boolean match)	Sets a auditor 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(String question, Type stringMatchType, boolean match)	Sets the question for this query.
void	matchRequired(boolean match)	Matches inquiries that are required.
boolean	supportsAuditorQuery()	Tests if a ResourceQuery is available.
boolean	supportsAuditQuery()	Tests if an AuditQuery is available.
boolean	supportsInquestQuery()	Tests if an InquestQuery is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Modifier and Type	Method	Description
void	clearActiveTerms()	Clears the active query terms.
void	clearDisabledTerms()	Clears the administratively disabled query terms.
void	clearEnabledTerms()	Clears the administratively enabled query terms.
void	clearOperationalTerms()	Clears the operational query terms.
void	matchActive(boolean match)	Matches active.
void	matchDisabled(boolean match)	Matches administratively disabled.
void	matchEnabled(boolean match)	Matches administratively enabled.
void	matchOperational(boolean match)	Matches operational operables.

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidRuleQuery

clearConditionRecordTypeTerms, clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyConditionRecordType, matchAnyRule, matchConditionRecordType, matchRuleId, supportsRuleQuery

Modifier and Type	Method	Description
void	clearConditionRecordTypeTerms()	Clears the condition record Type query terms.
void	clearRuleIdTerms()	Clears all rule Id terms.
void	clearRuleTerms()	Clears all rule terms.
RuleQuery	getRuleQuery(boolean match)	Gets the query for the rule.
void	matchAnyConditionRecordType(boolean match)	Matches rules with any condition record type.
void	matchAnyRule(boolean match)	Match any associated rule.
void	matchConditionRecordType(Type conditionRecordType, boolean match)	Matches a condition record type.
void	matchRuleId(Id ruleId, boolean match)	Match the Id of the rule.
boolean	supportsRuleQuery()	Tests if a RuleQuery for the rule is available.

Method Details

matchAuditorId

void matchAuditorId(Id auditorId,
 boolean match)

Sets a auditor Id for this query.

Parameters:

auditorId - a auditor Id

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

Throws:

NullArgumentException - auditorId is null

Compliance:

mandatory - This method must be implemented.

clearAuditorIdTerms

void clearAuditorIdTerms()

Clears the auditor Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAuditorQuery

boolean supportsAuditorQuery()

Tests if a ResourceQuery is available.

Returns:

true if a auditor query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAuditorQuery

ResourceQuery getAuditorQuery()

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

Returns:

the auditor query

Throws:

UnimplementedException - supportsAuditorQuery() is false

Compliance:

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

matchAnyAuditor

void matchAnyAuditor(boolean match)

Matches objects with any auditor.

Parameters:

match - true to match objects with any auditor, false to match objects with no auditor

Compliance:

mandatory - This method must be implemented.

clearAuditorTerms

void clearAuditorTerms()

Clears the auditor query terms.

Compliance:

mandatory - This method must be implemented.

matchAuditId

void matchAuditId(Id auditId,
 boolean match)

Sets the audit Id for this query.

Parameters:

auditId - the audit Id

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

Throws:

NullArgumentException - auditId is null

Compliance:

mandatory - This method must be implemented.

clearAuditIdTerms

void clearAuditIdTerms()

Clears the audit Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAuditQuery

boolean supportsAuditQuery()

Tests if an AuditQuery is available.

Returns:

true if an audit query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAuditQuery

AuditQuery getAuditQuery()

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

Returns:

the audit query

Throws:

UnimplementedException - supportsAuditQuery() is false

Compliance:

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

clearAuditTerms

void clearAuditTerms()

Clears the audit query terms.

Compliance:

mandatory - This method must be implemented.

matchQuestion

void matchQuestion(String question,
 Type stringMatchType,
 boolean match)

Sets the question for this query.

Parameters:

question - the question

stringMatchType - a string match type

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

Throws:

NullArgumentException - question or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyQuestion

void matchAnyQuestion(boolean match)

Matches inquiries with any question.

Parameters:

match - true to match inquiries with a question, false to match inquiries with no question

Compliance:

mandatory - This method must be implemented.

clearQuestionTerms

void clearQuestionTerms()

Clears the question query terms.

Compliance:

mandatory - This method must be implemented.

matchRequired

void matchRequired(boolean match)

Matches inquiries that are required.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

matchAnyRequired

void matchAnyRequired(boolean match)

Matches inquiries with any required flag set.

Parameters:

match - true to match inquiries with a required flag set, false to match inquiries with no required flag set

Compliance:

mandatory - This method must be implemented.

clearRequiredTerms

void clearRequiredTerms()

Clears the required query terms.

Compliance:

mandatory - This method must be implemented.

matchAffirmationRequired

void matchAffirmationRequired(boolean match)

Matches inquiries that require a positive response.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

matchAnyAffirmationRequired

void matchAnyAffirmationRequired(boolean match)

Matches inquiries with any affirmation required flag set.

Parameters:

match - true to match inquiries with an affirmation required flag set, false to match inquiries with no affirmation required flag set

Compliance:

mandatory - This method must be implemented.

clearAffirmationRequiredTerms

void clearAffirmationRequiredTerms()

Clears the affirmation required query terms.

Compliance:

mandatory - This method must be implemented.

matchNeedsOneResponse

void matchNeedsOneResponse(boolean match)

Matches inquiries that require a single response.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

matchAnyNeedsOneResponse

void matchAnyNeedsOneResponse(boolean match)

Matches inquiries with any needs one response set.

Parameters:

match - true to match inquiries with a need one response flag set, false to match inquiries with no needs one response flag set

Compliance:

mandatory - This method must be implemented.

clearNeedsOneResponseTerms

void clearNeedsOneResponseTerms()

Clears the needs one response 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 inquiries 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.

getInquiryQueryRecord

InquiryQueryRecord getInquiryQueryRecord(Type inquiryRecordType)
                                  throws OperationFailedException

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

Parameters:

inquiryRecordType - an inquiry record type

Returns:

the inquiry query record

Throws:

NullArgumentException - inquiryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inquiryRecordType) is false

Compliance:

mandatory - This method must be implemented.