public interface EngineQueryInspector extends OsidCatalogQueryInspector
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[] |
getAncestorEngineIdTerms()
Gets the ancestor engine
Id query terms. |
EngineQueryInspector[] |
getAncestorEngineTerms()
Gets the ancestor engine query terms.
|
IdTerm[] |
getDescendantEngineIdTerms()
Gets the descendant engine
Id query terms. |
EngineQueryInspector[] |
getDescendantEngineTerms()
Gets the descendant engine query terms.
|
EngineQueryInspectorRecord |
getEngineQueryInspectorRecord(Type engineRecordType)
Gets the engine query inspector record corresponding to the given
Engine record Type. |
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
getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms
IdTerm[] getAncestorEngineIdTerms()
Id
query terms. Id
termsmandatory
- This method must be implemented. EngineQueryInspector[] getAncestorEngineTerms()
mandatory
- This method must be implemented. IdTerm[] getDescendantEngineIdTerms()
Id
query terms. Id
termsmandatory
- This method must be implemented. EngineQueryInspector[] getDescendantEngineTerms()
mandatory
- This method must be implemented. EngineQueryInspectorRecord getEngineQueryInspectorRecord(Type engineRecordType) throws OperationFailedException, PermissionDeniedException
Engine
record Type.
Multiple record
retrievals produce a nested boolean OR
term.engineRecordType
- an engine record typeNullArgumentException
- engineRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(engineRecordType)
is false
mandatory
- This method must be implemented.