|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ErrorHelper is an interface which defines the methods needed for the AEF Error Handler to handle application errors.
Field Summary | |
---|---|
static int |
ERROR_HANDLED
|
static int |
ERROR_IS_FATAL
|
Method Summary | |
---|---|
java.lang.String |
getCurrentState()
Gets the current state. |
com.ibm.retail.si.util.AEFError |
getError()
Gets the error that we are working on. |
com.ibm.retail.AEF.util.AEFErrorHandler |
getErrorHandler()
Gets the Error Handler that created this Error Helper. |
com.ibm.retail.si.util.AEFException |
getOuterException()
Returns the outer most Exception (if any) that was thrown while handling this error. |
int |
getSleepInterval()
Returns the number of milliseconds to wait before continuing with the next operation while handling errors. |
int |
handleError(com.ibm.retail.AEF.thread.ConditionLock lock,
com.ibm.retail.AEF.action.AEFAction keySequenceAction,
com.ibm.retail.AEF.automation.Condition[] goodConditions,
com.ibm.retail.AEF.automation.Condition[] badConditions,
int timeout,
int satisfiedCondition)
Tries to resolve the error condition if possible. |
boolean |
isEmulatedDevice(com.ibm.retail.AEF.io.DeviceRegistry deviceRegistry,
java.lang.String logicalName)
IsEmulatedDevice Used to determine if a device is real or emulated. |
boolean |
isEmulatedDevice(java.lang.String logicalName)
IsEmulatedDevice Used to determine if a device is real or emulated. |
void |
resetInputDevices()
Reset the input devices |
void |
setError(com.ibm.retail.si.util.AEFError theError)
Sets the error that we are working on. |
void |
setErrorHandler(com.ibm.retail.AEF.util.AEFErrorHandler theErrorHandler)
Sets the Error Handler that created this Error Helper. |
void |
setInputDevicesLocked(boolean flag)
Lock the input devices |
void |
setOuterException(com.ibm.retail.si.util.AEFException theException)
Sets the outer most Exception that was thrown while handling this error. |
void |
sleep()
Causes the Error Helper to wait before continuing with the next operation. |
void |
sleep(int userInterval)
Causes the Error Helper to wait before continuing with the next operation. |
Field Detail |
public static final int ERROR_HANDLED
public static final int ERROR_IS_FATAL
Method Detail |
public com.ibm.retail.si.util.AEFError getError()
public void setError(com.ibm.retail.si.util.AEFError theError)
theError
- The AEFError object that contains the information about
the error we are trying to handle.public int handleError(com.ibm.retail.AEF.thread.ConditionLock lock, com.ibm.retail.AEF.action.AEFAction keySequenceAction, com.ibm.retail.AEF.automation.Condition[] goodConditions, com.ibm.retail.AEF.automation.Condition[] badConditions, int timeout, int satisfiedCondition)
lock
- The ConditionLock that returned the error.keySequenceAction
- The key sequence that generated the error.goodConditions
- An array of the conditions that would indicate
success after the key sequence is sent.badConditions
- An array of the conditions that would indicate a
failure after the key sequence is sent.timeout
- An integer used to determine how long to wait for one of
the listed conditions before a timeout exception is thrown.satisfiedCondition
- The index of the condition in the badConditions
array that was satisfied on the last wait(needs to be adjusted as
it is a negative number).
public com.ibm.retail.si.util.AEFException getOuterException()
public void setOuterException(com.ibm.retail.si.util.AEFException theException)
public int getSleepInterval()
public void sleep()
public void sleep(int userInterval)
userInterval
- A user specified interval to be used instead of the default
sleep value.public boolean isEmulatedDevice(java.lang.String logicalName) throws AEFException
logicalName
- The JPOS logical name for the device.
AEFException
- Among the possible AEFException error codes are:
public boolean isEmulatedDevice(com.ibm.retail.AEF.io.DeviceRegistry deviceRegistry, java.lang.String logicalName) throws jpos.JposException
deviceRegistry
- The device registry for this session.logicalName
- The JPOS logical name for the device.
JposException
public java.lang.String getCurrentState()
public void setInputDevicesLocked(boolean flag) throws AEFException
flag
- A boolean that indicates if the are locking or unlocking the input devices.
AEFException
- Among the possible AEFException error codes are:
public void resetInputDevices() throws AEFException
AEFException
- Among the possible AEFException error codes are:
public com.ibm.retail.AEF.util.AEFErrorHandler getErrorHandler()
public void setErrorHandler(com.ibm.retail.AEF.util.AEFErrorHandler theErrorHandler)
theErrorHandler
- The Error Handler that created this Error Helper.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |