org.osid.inquiry

Interface InquiryQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector, OsidSubjugateableQueryInspector

public interface InquiryQueryInspector
extends OsidRuleQueryInspector, OsidSubjugateableQueryInspector

This is the query inspector for examining inquiry queries.

Method Summary

Methods

Modifier and Type	Method and Description
BooleanTerm[]	getAffirmationRequiredTerms() Gets the affirmation required query terms.
IdTerm[]	getAuditIdTerms() Gets the audit Id query terms.
AuditQueryInspector[]	getAuditTerms() Gets the audit query terms.
IdTerm[]	getInquestIdTerms() Gets the inquest Id query terms.
InquestQueryInspector[]	getInquestTerms() Gets the inquest query terms.
InquiryQueryInspectorRecord	getInquiryQueryInspectorRecord(Type inquiryRecordType) Gets the inquiry query inspector record corresponding to the given Inquiry record Type.
BooleanTerm[]	getNeedsOneResponseTerms() Gets the needs one response query terms.
StringTerm[]	getQuestionTerms() Gets the question query terms.
BooleanTerm[]	getRequiredTerms() Gets the required query terms.

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Method Detail

getAuditIdTerms

IdTerm[] getAuditIdTerms()

Gets the audit Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAuditTerms

AuditQueryInspector[] getAuditTerms()

Gets the audit query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getQuestionTerms

StringTerm[] getQuestionTerms()

Gets the question query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequiredTerms

BooleanTerm[] getRequiredTerms()

Gets the required query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAffirmationRequiredTerms

BooleanTerm[] getAffirmationRequiredTerms()

Gets the affirmation required query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getNeedsOneResponseTerms

BooleanTerm[] getNeedsOneResponseTerms()

Gets the needs one response query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getInquestIdTerms

IdTerm[] getInquestIdTerms()

Gets the inquest Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getInquestTerms

InquestQueryInspector[] getInquestTerms()

Gets the inquest query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getInquiryQueryInspectorRecord

InquiryQueryInspectorRecord getInquiryQueryInspectorRecord(Type inquiryRecordType)
                                                           throws OperationFailedException

Gets the inquiry query inspector record corresponding to the given Inquiry record Type.

Parameters:

inquiryRecordType - an inquiry record type

Returns:

the inquiry query inspector record

Throws:

NullArgumentException - inquiryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inquiryRecordType) is false

Compliance:

mandatory - This method must be implemented.