Interface InstructionQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidEnablerQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidRuleApplicatorQueryInspector, OsidRuleQueryInspector, OsidTemporalQueryInspector
public interface InstructionQueryInspector extends OsidRelationshipQueryInspector, OsidRuleApplicatorQueryInspector

This is the query inspector for examining instruction queries.

  • Method Details

    • getAgendaIdTerms

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

    • getAgendaTerms

      AgendaQueryInspector[] getAgendaTerms()
      Gets the agenda query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCheckIdTerms

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

    • getCheckTerms

      CheckQueryInspector[] getCheckTerms()
      Gets the check query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getMessageTerms

      StringTerm[] getMessageTerms()
      Gets the message query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getWarningTerms

      BooleanTerm[] getWarningTerms()
      Gets the warning query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getContinueOnFailTerms

      BooleanTerm[] getContinueOnFailTerms()
      Gets the continue-on-fail query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getBreakOnSuccessTerms

      BooleanTerm[] getBreakOnSuccessTerms()
      Gets the continue-on-fail query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getEngineIdTerms

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

    • getEngineTerms

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

    • getOrderTerms

      IntegerRangeTerm[] getOrderTerms()
      Gets the order query terms.
      Returns:
      the order terms
      Compliance:
      mandatory - This method must be implemented.

    • getInstructionQueryInspectorRecord

      InstructionQueryInspectorRecord getInstructionQueryInspectorRecord(Type instructionRecordType) throws OperationFailedException, PermissionDeniedException
      Gets the instruction query inspector record corresponding to the given Instruction record Type .
      Parameters:
      instructionRecordType - an instruction record type
      Returns:
      the instruction query inspector record
      Throws:
      NullArgumentException - instructionRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - hasRecordType(instructionRecordType) is false
      Compliance:
      mandatory - This method must be implemented.