Package gda.device

Interface ActionApprover

All Superinterfaces:
Serializable
All Known Subinterfaces:
ActionRule
All Known Implementing Classes:
ActionRuleBase, ActionRuleDevicesEnabled, ActionRuleNull, ActiveHutchApprover, ActiveHutchApprover, ActiveStaffApprover, BatonBasedActionApprover, CompoundApprover
public interface ActionApprover extends Serializable
Interface for classes which perform tests on the current status/position of equipment before operations are made which could cause damage or effect the flow of the experiment

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    actionApproved()
    Performs the test that the object encapsulates and returns the result of that test.
    String
    getDenialReason()
    Returns an explanation of why the last call to actionApproved returned false.

  • Method Details

    • actionApproved

      boolean actionApproved() throws DeviceException
      Performs the test that the object encapsulates and returns the result of that test.
      Returns:
      true if operation would be OK to perform
      Throws:
      DeviceException - - thrown if an error occurred while inquiring into device objects' status

    • getDenialReason

      String getDenialReason()
      Returns an explanation of why the last call to actionApproved returned false.
      Returns:
      string