Interface Instruction

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidEnabler, OsidObject, OsidRelationship, OsidRule, OsidRuleApplicator, Temporal
public interface Instruction extends OsidRelationship, OsidRuleApplicator

A Instruction appliies a Check to an Agenda .

  • Method Details

    • getAgendaId

      Id getAgendaId()
      Gets the Id of the agenda.
      Returns:
      the agenda Id
      Compliance:
      mandatory - This method must be implemented.

    • getAgenda

      Agenda getAgenda() throws OperationFailedException
      Gets the agenda.
      Returns:
      the agenda
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getCheckId

      Id getCheckId()
      Gets the Id of the check.
      Returns:
      the check Id
      Compliance:
      mandatory - This method must be implemented.

    • getCheck

      Check getCheck() throws OperationFailedException
      Gets the check.
      Returns:
      the check
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getMessage

      DisplayText getMessage()
      Gets the message to be returned upon failure of the check evaluation.
      Returns:
      the message
      Compliance:
      mandatory - This method must be implemented.

    • isWarning

      boolean isWarning()
      Tests if failure of the check should be interpreted as a warning and not a failure.
      Returns:
      true if this is a warning, false if an error
      Compliance:
      mandatory - This method must be implemented.

    • continueOnFail

      boolean continueOnFail()
      Tests if evaluation of the next instruction should continue if the check in this instruction fails. While the overall evaluation of the agenda still fails, if true, allows for other messages to be gathered.
      Returns:
      true if this processing should continue on failure, false if processing should cease upon failure
      Compliance:
      mandatory - This method must be implemented.

    • breakOnSuccess

      boolean breakOnSuccess()
      Tests if evaluation of the next instruction should continue if the check in this instruction succeeds. This flag instructs the evaluator to stop evaluation and return success if this check is positive.
      Returns:
      true if this processing should break on success, false if processing should continue
      Compliance:
      mandatory - This method must be implemented.

    • order

      long order()
      The processing order for this Instruction .
      Returns:
      the processing order
      Compliance:
      mandatory - This method must be implemented.

    • getInstructionRecord

      InstructionRecord getInstructionRecord(Type instructionRecordType) throws OperationFailedException, PermissionDeniedException
      Gets the instruction record corresponding to the given Instruction record Type . This method is used to retrieve an object implementing the requested record. The instructionRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(instructionRecordType) is true .
      Parameters:
      instructionRecordType - the type of instruction record to retrieve
      Returns:
      the instruction 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.