Package de.gmxhome.conrad.jpos.jpos_base.pospower

Class POSPowerProperties

java.lang.Object
de.gmxhome.conrad.jpos.jpos_base.JposCommonProperties
de.gmxhome.conrad.jpos.jpos_base.pospower.POSPowerProperties
All Implemented Interfaces:
JposBaseInterface, POSPowerInterface
public class POSPowerProperties extends JposCommonProperties implements POSPowerInterface
Class containing the POS Power specific properties, their default values and default implementations of POSPowerInterface. For details about properties, methods and method parameters, see UPOS specification, chapter POS Power.

  • Field Details

    • CapBatteryCapacityRemaining

      public boolean CapBatteryCapacityRemaining
      UPOS property CapBatteryCapacityRemaining. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapFanAlarm

      public boolean CapFanAlarm
      UPOS property CapFanAlarm. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapHeatAlarm

      public boolean CapHeatAlarm
      UPOS property CapHeatAlarm. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapQuickCharge

      public boolean CapQuickCharge
      UPOS property CapQuickCharge. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapRestartPOS

      public boolean CapRestartPOS
      UPOS property CapRestartPOS. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapShutdownPOS

      public boolean CapShutdownPOS
      UPOS property CapShutdownPOS. Default: true. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapStandbyPOS

      public boolean CapStandbyPOS
      UPOS property CapStandbyPOS. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapSuspendPOS

      public boolean CapSuspendPOS
      UPOS property CapSuspendPOS. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapUPSChargeState

      public int CapUPSChargeState
      UPOS property CapUPSChargeState. Default: 0. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapVariableBatteryCriticallyLowThreshold

      public boolean CapVariableBatteryCriticallyLowThreshold
      UPOS property CapVariableBatteryCriticallyLowThreshold. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapVariableBatteryLowThreshold

      public boolean CapVariableBatteryLowThreshold
      UPOS property CapVariableBatteryLowThreshold. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • BatteryCapacityRemaining

      public int BatteryCapacityRemaining
      UPOS property BatteryCapacityRemaining. Default: 0. Should be set to an initial value in the open method if CapBatteryCapacityRemaining is true.

    • BatteryCriticallyLowThreshold

      public int BatteryCriticallyLowThreshold
      UPOS property BatteryCriticallyLowThreshold. Default: 0. Should be overwritten by objects derived from JposDevice within the open method if CapVariableBatteryCriticallyLowThreshold is true.

    • BatteryLowThreshold

      public int BatteryLowThreshold
      UPOS property BatteryLowThreshold. Default: 0. Should be overwritten by objects derived from JposDevice within the open method if CapVariableBatteryLowThreshold is true.

    • EnforcedShutdownDelayTime

      public int EnforcedShutdownDelayTime
      UPOS property EnforcedShutdownDelayTime. Default: 0. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • PowerFailDelayTime

      public int PowerFailDelayTime
      UPOS property PowerFailDelayTime. Default: 0. Can be initialized by objects derived from JposDevice within the changeDefaults or open method.

    • PowerSource

      public int PowerSource
      UPOS property PowerSource. Default: SOURCE_NA. Should be initialized by objects derived from JposDevice within the open method.

    • QuickChargeMode

      public boolean QuickChargeMode
      UPOS property QuickChargeMode. Default: false. Should be overwritten by objects derived from JposDevice within the open method if CapQuickCharge is true.

    • QuickChargeTime

      public int QuickChargeTime
      UPOS property QuickChargeTime. Default: 0. Should be overwritten by objects derived from JposDevice within the open method if CapQuickCharge is true.

    • UPSChargeState

      public int UPSChargeState
      UPOS property UPSChargeState. Default: 0. Must be overwritten by objects derived from JposDevice whenever DeviceEnabled will be set to true if CapUPSChargeState is not 0.

    • BatteryCapacityRemainingInSeconds

      public int BatteryCapacityRemainingInSeconds
      UPOS property BatteryCapacityRemainingInSeconds. Default: 0. Should be overwritten by objects derived from JposDevice within the open method if CapBatteryCapacityRemainingInSeconds is true.

    • BatteryCriticallyLowThresholdInSeconds

      public int BatteryCriticallyLowThresholdInSeconds
      UPOS property BatteryCriticallyLowThresholdInSeconds. Default: 0. Should be overwritten by objects derived from JposDevice within the open method if CapVariableBatteryCriticallyLowThresholdInSeconds is true.

    • BatteryLowThresholdInSeconds

      public int BatteryLowThresholdInSeconds
      UPOS property BatteryLowThresholdInSeconds. Default: 0. Should be overwritten by objects derived from JposDevice within the open method if CapVariableBatteryLowThresholdInSeconds is true.

    • CapBatteryCapacityRemainingInSeconds

      public boolean CapBatteryCapacityRemainingInSeconds
      UPOS property CapBatteryCapacityRemainingInSeconds. Default: false. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapChargeTime

      public boolean CapChargeTime
      UPOS property CapChargeTime. Default: false. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapVariableBatteryCriticallyLowThresholdInSeconds

      public boolean CapVariableBatteryCriticallyLowThresholdInSeconds
      UPOS property CapVariableBatteryCriticallyLowThresholdInSeconds. Default: false. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapVariableBatteryLowThresholdInSeconds

      public boolean CapVariableBatteryLowThresholdInSeconds
      UPOS property CapVariableBatteryLowThresholdInSeconds. Default: false. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • ChargeTime

      public int ChargeTime
      UPOS property ChargeTime. Default: 0. Should be overwritten by objects derived from JposDevice within the open method if CapChargeTime is true.

  • Constructor Details

    • POSPowerProperties

      protected POSPowerProperties​(int dev)
      Constructor. Sets ExclusiveUse to ExclusiveAllowed to match the POSPower device model.
      Parameters:
      dev - Device index

  • Method Details

    • batteryCriticallyLowThreshold

      public void batteryCriticallyLowThreshold​(int threshold) throws jpos.JposException
      Description copied from interface: POSPowerInterface
      Final part of setBatteryCriticallyLowThreshold method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • threshold is between 0 and 99.
      Specified by:
      batteryCriticallyLowThreshold in interface POSPowerInterface
      Parameters:
      threshold - Critical battery low power level in percent.
      Throws:
      jpos.JposException - If an error occurs.

    • batteryLowThreshold

      public void batteryLowThreshold​(int threshold) throws jpos.JposException
      Description copied from interface: POSPowerInterface
      Final part of setBatteryLowThreshold method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device has been opened,
      • threshold is between 0 and 99.
      Specified by:
      batteryLowThreshold in interface POSPowerInterface
      Parameters:
      threshold - Battery low power level in percent.
      Throws:
      jpos.JposException - If an error occurs.

    • setBatteryCriticallyLowThresholdInSeconds

      public void setBatteryCriticallyLowThresholdInSeconds​(int seconds) throws jpos.JposException
      Description copied from interface: POSPowerInterface
      Final part of setBatteryCriticallyLowThresholdInSeconds method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device has been opened,
      • CapVariableBatteryCriticallyLowThresholdInSeconds is true,
      • seconds is a positive value.
      Specified by:
      setBatteryCriticallyLowThresholdInSeconds in interface POSPowerInterface
      Parameters:
      seconds - Critical battery low power level in seconds.
      Throws:
      jpos.JposException - If an error occurs.

    • setBatteryLowThresholdInSeconds

      public void setBatteryLowThresholdInSeconds​(int seconds) throws jpos.JposException
      Description copied from interface: POSPowerInterface
      Final part of setBatteryLowThresholdInSeconds method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device has been opened,
      • CapVariableBatteryLowThresholdInSeconds is true,
      • seconds is a positive value.
      Specified by:
      setBatteryLowThresholdInSeconds in interface POSPowerInterface
      Parameters:
      seconds - Battery low power level in seconds.
      Throws:
      jpos.JposException - If an error occurs.

    • enforcedShutdownDelayTime

      public void enforcedShutdownDelayTime​(int delay) throws jpos.JposException
      Description copied from interface: POSPowerInterface
      Final part of setEnforcedShutdownDelayTime method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device has been opened,
      • delay is ≥ 0.
      Specified by:
      enforcedShutdownDelayTime in interface POSPowerInterface
      Parameters:
      delay - Time delay for shutdown.
      Throws:
      jpos.JposException - If an error occurs.

    • restartPOS

      public void restartPOS() throws jpos.JposException
      Description copied from interface: POSPowerInterface
      Final part of restartPOS method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled.
      • Device has not been claimed by another instance of this device.
      • CapRestartPOS is true.
      Specified by:
      restartPOS in interface POSPowerInterface
      Throws:
      jpos.JposException - If an error occurs.

    • shutdownPOS

      public void shutdownPOS() throws jpos.JposException
      Description copied from interface: POSPowerInterface
      Final part of shutdownPOS method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled.
      • Device has not been claimed by another instance of this device.
      • CapShutdownPOS is true.
      Specified by:
      shutdownPOS in interface POSPowerInterface
      Throws:
      jpos.JposException - If an error occurs.

    • standbyPOS

      public void standbyPOS​(int reason) throws jpos.JposException
      Description copied from interface: POSPowerInterface
      Final part of standbyPOS method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled.
      • Device has not been claimed by another instance of this device,
      • reason is one of REASON_REQUEST, REASON_ALLOW or REASON_DENY,
      • CapStandbyPOS is true or reason ≠ REASON_REQUEST.
      Specified by:
      standbyPOS in interface POSPowerInterface
      Parameters:
      reason - Reason for the call. See UPOS specification.
      Throws:
      jpos.JposException - If an error occurs.

    • suspendPOS

      public void suspendPOS​(int reason) throws jpos.JposException
      Description copied from interface: POSPowerInterface
      Final part of suspendPOS method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled.
      • Device has not been claimed by another instance of this device,
      • reason is one of REASON_REQUEST, REASON_ALLOW or REASON_DENY,
      • CapSuspendPOS is true or reason ≠ REASON_REQUEST.
      Specified by:
      suspendPOS in interface POSPowerInterface
      Parameters:
      reason - Reason for the call. See UPOS specification.
      Throws:
      jpos.JposException - If an error occurs.