org.osid.inquiry

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

Methods

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.

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

Methods inherited from interface org.osid.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 org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

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

Method Detail

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 supportAuditQuery() is true.

clearAuditTerms

void clearAuditTerms()

Clears the audit query terms.

Compliance:

mandatory - This method must be implemented.

matchQuestion

void matchQuestion(java.lang.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 supportsInquestQuery() is 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.