Interface EngineQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
public interface EngineQueryInspector extends OsidCatalogQueryInspector

This is the query inspector for examining engine queries.

  • Method Details

    • getRuleIdTerms

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

    • getRuleTerms

      RuleQueryInspector[] getRuleTerms()
      Gets the rule query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorEngineIdTerms

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

    • getAncestorEngineTerms

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

    • getDescendantEngineIdTerms

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

    • getDescendantEngineTerms

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

    • getEngineQueryInspectorRecord

      EngineQueryInspectorRecord getEngineQueryInspectorRecord(Type engineRecordType) throws OperationFailedException
      Gets the engine query inspector record corresponding to the given Engine record Type .
      Parameters:
      engineRecordType - an engine record type
      Returns:
      the engine query inspector record
      Throws:
      NullArgumentException - engineRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(engineRecordType) is false
      Compliance:
      mandatory - This method must be implemented.