Interface EngineQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
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.

  • Method Details

    • getAncestorEngineIdTerms

      IdTerm[] getAncestorEngineIdTerms()
      Gets the ancestor engine Id query terms.
      Returns:
      the ancestor engine Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorEngineTerms

      EngineQueryInspector[] getAncestorEngineTerms()
      Gets the ancestor engine query terms.
      Returns:
      the ancestor engine terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantEngineIdTerms

      IdTerm[] getDescendantEngineIdTerms()
      Gets the descendant engine Id query terms.
      Returns:
      the descendant engine Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantEngineTerms

      EngineQueryInspector[] getDescendantEngineTerms()
      Gets the descendant engine query terms.
      Returns:
      the descendant engine terms
      Compliance:
      mandatory - This method must be implemented.

    • getEngineQueryInspectorRecord

      EngineQueryInspectorRecord getEngineQueryInspectorRecord(Type engineRecordType) throws OperationFailedException, PermissionDeniedException
      Gets the engine query inspector record corresponding to the given Engine record Type . Multiple record retrievals produce a nested boolean OR term.
      Parameters:
      engineRecordType - an engine record type
      Returns:
      the engine query inspector record
      Throws:
      NullArgumentException - engineRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - hasRecordType(engineRecordType) is false
      Compliance:
      mandatory - This method must be implemented.