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

Interface POSPowerInterface

All Superinterfaces:

JposBaseInterface

All Known Implementing Classes:

POSPowerProperties

public interface POSPowerInterface
extends JposBaseInterface

Interface for methods that implement property setter and method calls for the POSPower device category. For details about properties, methods and method parameters, see UPOS specification, chapter POS Power. Further details about error handling can be found in introduction - Device Behavior Models - Errors.

Method Summary

Modifier and Type	Method	Description
void	batteryCriticallyLowThreshold(int threshold)	Final part of setBatteryCriticallyLowThreshold method.
void	batteryLowThreshold(int threshold)	Final part of setBatteryLowThreshold method.
void	enforcedShutdownDelayTime(int delay)	Final part of setEnforcedShutdownDelayTime method.
void	restartPOS()	Final part of restartPOS method.
void	setBatteryCriticallyLowThresholdInSeconds(int seconds)	Final part of setBatteryCriticallyLowThresholdInSeconds method.
void	setBatteryLowThresholdInSeconds(int seconds)	Final part of setBatteryLowThresholdInSeconds method.
void	shutdownPOS()	Final part of shutdownPOS method.
void	standbyPOS(int reason)	Final part of standbyPOS method.
void	suspendPOS(int reason)	Final part of suspendPOS method.

Methods inherited from interface de.gmxhome.conrad.jpos.jpos_base.JposBaseInterface

asyncMode, autoDisable, checkHealth, claim, clearInput, clearOutput, close, compareFirmwareVersion, dataEventEnabled, deviceEnabled, directIO, directIO, flagWhenIdle, freezeEvents, handlePowerStateOnEnable, newJposOutputRequest, open, powerNotify, release, removeFromPropertySetList, resetStatistics, retrieveStatistics, retryInput, retryOutput, unitDataCount, updateFirmware, updateFirmware, updateStatistics

Method Details

batteryCriticallyLowThreshold

void batteryCriticallyLowThreshold(int threshold)
                            throws jpos.JposException

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.

Parameters:

threshold - Critical battery low power level in percent.

Throws:

jpos.JposException - If an error occurs.

batteryLowThreshold

void batteryLowThreshold(int threshold)
                  throws jpos.JposException

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.

Parameters:

threshold - Battery low power level in percent.

Throws:

jpos.JposException - If an error occurs.

setBatteryCriticallyLowThresholdInSeconds

void setBatteryCriticallyLowThresholdInSeconds(int seconds)
                                        throws jpos.JposException

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.

Parameters:

seconds - Critical battery low power level in seconds.

Throws:

jpos.JposException - If an error occurs.

setBatteryLowThresholdInSeconds

void setBatteryLowThresholdInSeconds(int seconds)
                              throws jpos.JposException

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.

Parameters:

seconds - Battery low power level in seconds.

Throws:

jpos.JposException - If an error occurs.

enforcedShutdownDelayTime

void enforcedShutdownDelayTime(int delay)
                        throws jpos.JposException

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.

Parameters:

delay - Time delay for shutdown.

Throws:

jpos.JposException - If an error occurs.

restartPOS

void restartPOS()
         throws jpos.JposException

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.

Throws:

jpos.JposException - If an error occurs.

shutdownPOS

void shutdownPOS()
          throws jpos.JposException

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.

Throws:

jpos.JposException - If an error occurs.

standbyPOS

void standbyPOS(int reason)
         throws jpos.JposException

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.

Parameters:

reason - Reason for the call. See UPOS specification.

Throws:

jpos.JposException - If an error occurs.

suspendPOS

void suspendPOS(int reason)
         throws jpos.JposException

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.

Parameters:

reason - Reason for the call. See UPOS specification.

Throws:

jpos.JposException - If an error occurs.