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
Modifier and TypeMethodDescriptionIdTerm[]Gets the answerIdquery terms.Gets the answer query terms.IdTerm[]Gets the assessmentIdquery terms.Gets the assessment query terms.IdTerm[]Gets the bankIdquery terms.Gets the bank query terms.getItemQueryInspectorRecord(Type itemRecordType) Gets the record query inspector corresponding to the givenItemrecordType.IdTerm[]Gets the learning objectiveIdquery terms.Gets the learning objective query terms.IdTerm[]Gets the questionIdquery terms.Gets the question query terms.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidExtensibleQueryInspector
getRecordTypeTermsMethods inherited from interface OsidIdentifiableQueryInspector
getIdTermsMethods inherited from interface OsidObjectQueryInspector
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTermsModifier and TypeMethodDescriptionIdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the subject relevancy query terms.Gets the subject query terms.Methods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.
-
Method Details
-
getLearningObjectiveIdTerms
IdTerm[] getLearningObjectiveIdTerms()Gets the learning objectiveIdquery terms.- Returns:
- the learning objective
Idterms - 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 questionIdquery terms.- Returns:
- the question
Idterms - 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 answerIdquery terms.- Returns:
- the answer
Idterms - 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 assessmentIdquery terms.- Returns:
- the assessment
Idterms - 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 bankIdquery terms.- Returns:
- the bank
Idterms - 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 givenItemrecordType.- Parameters:
itemRecordType- an item record type- Returns:
- the item query inspector record
- Throws:
NullArgumentException-itemRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(itemRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-