public interface ResultQueryInspector extends OsidObjectQueryInspector, OsidTemporalQueryInspector, OsidSubjugateableQueryInspector
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.
Modifier and Type | Method and Description |
---|---|
IdTerm[] |
getCatalogueIdTerms()
Gets the catalogue
Id query terms. |
CatalogueQueryInspector[] |
getCatalogueTerms()
Gets the catalogue query terms.
|
IdTerm[] |
getGradeIdTerms()
Gets the grade
Id query terms. |
GradeQueryInspector[] |
getGradeTerms()
Gets the grade query terms.
|
IdTerm[] |
getParticipantIdTerms()
Gets the participant
Id query terms. |
ParticipantQueryInspector[] |
getParticipantTerms()
Gets the participant query terms.
|
ResultQueryInspectorRecord |
getResultQueryInspectorRecord(Type resultRecordType)
Gets the result query inspector record corresponding to the given
Result record Type. |
DecimalRangeTerm[] |
getValueTerms()
Gets the value query terms.
|
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms
getIdTerms
getRecordTypeTerms
getRecordTypes, hasRecordType
getAnyTerms, getKeywordTerms
getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms
IdTerm[] getParticipantIdTerms()
Id
query terms. Id
termsmandatory
- This method must be implemented. ParticipantQueryInspector[] getParticipantTerms()
mandatory
- This method must be implemented. IdTerm[] getGradeIdTerms()
Id
query terms. Id
termsmandatory
- This method must be implemented. GradeQueryInspector[] getGradeTerms()
mandatory
- This method must be implemented. DecimalRangeTerm[] getValueTerms()
mandatory
- This method must be implemented. IdTerm[] getCatalogueIdTerms()
Id
query terms. Id
termsmandatory
- This method must be implemented. CatalogueQueryInspector[] getCatalogueTerms()
mandatory
- This method must be implemented. ResultQueryInspectorRecord getResultQueryInspectorRecord(Type resultRecordType) throws OperationFailedException
Result
record Type.
resultRecordType
- an result record typeNullArgumentException
- resultRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(resultRecordType)
is false
mandatory
- This method must be implemented.