org.osid.assessment

Interface ItemQueryInspector

All Superinterfaces:

Extensible, OsidAggregateableQueryInspector, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface ItemQueryInspector
extends OsidObjectQueryInspector, OsidAggregateableQueryInspector

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to OsidQuery interfaces for reuse or modification in the search sessions.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAnswerIdTerms() Gets the answer Id query terms.
AnswerQueryInspector[]	getAnswerTerms() Gets the answer query terms.
IdTerm[]	getAssessmentIdTerms() Gets the assessment Id query terms.
AssessmentQueryInspector[]	getAssessmentTerms() Gets the assessment query terms.
IdTerm[]	getBankIdTerms() Gets the bank Id query terms.
BankQueryInspector[]	getBankTerms() Gets the bank query terms.
ItemQueryInspectorRecord	getItemQueryInspectorRecord(Type itemRecordType) Gets the record query inspector corresponding to the given Item record Type.
IdTerm[]	getLearningObjectiveIdTerms() Gets the learning objective Id query terms.
ObjectiveQueryInspector[]	getLearningObjectiveTerms() Gets the learning objective query terms.
IdTerm[]	getQuestionIdTerms() Gets the question Id query terms.
QuestionQueryInspector[]	getQuestionTerms() Gets the question query terms.

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

Method Detail

getLearningObjectiveIdTerms

IdTerm[] getLearningObjectiveIdTerms()

Gets the learning objective Id query terms.

Returns:

the learning objective Id terms

Compliance:

mandatory - This method must be implemented.

getLearningObjectiveTerms

ObjectiveQueryInspector[] getLearningObjectiveTerms()

Gets the learning objective query terms.

Returns:

the learning objective terms

Compliance:

mandatory - This method must be implemented.

getQuestionIdTerms

IdTerm[] getQuestionIdTerms()

Gets the question Id query terms.

Returns:

the question Id terms

Compliance:

mandatory - This method must be implemented.

getQuestionTerms

QuestionQueryInspector[] getQuestionTerms()

Gets the question query terms.

Returns:

the question terms

Compliance:

mandatory - This method must be implemented.

getAnswerIdTerms

IdTerm[] getAnswerIdTerms()

Gets the answer Id query terms.

Returns:

the answer Id terms

Compliance:

mandatory - This method must be implemented.

getAnswerTerms

AnswerQueryInspector[] getAnswerTerms()

Gets the answer query terms.

Returns:

the answer terms

Compliance:

mandatory - This method must be implemented.

getAssessmentIdTerms

IdTerm[] getAssessmentIdTerms()

Gets the assessment Id query terms.

Returns:

the assessment Id terms

Compliance:

mandatory - This method must be implemented.

getAssessmentTerms

AssessmentQueryInspector[] getAssessmentTerms()

Gets the assessment query terms.

Returns:

the assessment terms

Compliance:

mandatory - This method must be implemented.

getBankIdTerms

IdTerm[] getBankIdTerms()

Gets the bank Id query terms.

Returns:

the bank Id terms

Compliance:

mandatory - This method must be implemented.

getBankTerms

BankQueryInspector[] getBankTerms()

Gets the bank query terms.

Returns:

the bank terms

Compliance:

mandatory - This method must be implemented.

getItemQueryInspectorRecord

ItemQueryInspectorRecord getItemQueryInspectorRecord(Type itemRecordType)
                                                     throws OperationFailedException

Gets the record query inspector corresponding to the given Item record Type.

Parameters:

itemRecordType - an item record type

Returns:

the item query inspector record

Throws:

NullArgumentException - itemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(itemRecordType) is false

Compliance:

mandatory - This method must be implemented.