JXFS event parameters

The following tables describe the JXFS event parameters (the parameter's HashTable elements of the event) for the different event types.
Table 1. All event types
Parameter Type Description
when Date The timestamp when the event was created.
Table 2. IntermediateEvent
Parameter Type Description
operationID Integer Identification of the operation type.
identificationID Integer Unique identification of the operation, -1 if not used.
reason Integer Reason for the event (example: JXFS_I_CDR_DISPENSE_DELAYED).
data Java™ data type or JxfsType subclass Optional added data for the application or null
Table 3. OperationCompleteEvent
Parameter Type Description
operationID Integer Identification of the operation type.
identificationID Integer Unique identification of the operation, -1 if not used.
result Integer The detailed operation result. It is JXFS_RC_SUCCESSFUL if successful.
extendedresult Integer Additional result specification. It is a device-specific value. This is device-dependent. -1 if not used.
data Java data type or JxfsType subclass Optional added data for the application or null
Table 4. StatusEvent
Parameter Type Description
status Integer The current status of the affected device. See the table below for details. Each specific device type also adds some more status codes.
details JxfsStatus or subclass of it The detailed status condition of the device, when the given status does not give the exact and complete status change information. If the status information is complete, this is null.

The following table describes the constant values for the status parameter of the StatusEvent:

Table 5. StatusEvent parameters
Status Constant Description
JXFS_S_CLAIMED Sent if the device was claimed.
JXFS_S_RELEASED Sent if the device was just released by the Device Control that had claimed the device.
JXFS_S_HARDWAREERROR Sent if a hardware error was detected by the Device Service.
JXFS_S_USERACTIONERROR Sent if an error was detected that is resolvable by user intervention.

If a more specific Status Event is generated regarding this error (for example, TONER_OUT), then no additional event with this id is sent.
JXFS_S_WORKING Sent to indicate that an error has been fixed and the device is working again.
JXFS_S_SHUTDOWN The device service has completed its shutdown and is not usable any more.
JXFS_S_REMOTEFAILURE Communication between Device Service and Device Control has failed; the device is no longer accessible.
JXFS_S_POWERSAVEON Device has gone into power save mode.
JXFS_S_POWERSAVEOFF Device has returned from power save mode.
Note: The JXFS Service gets J/XFS events from the J/XFS Device Control and transforms them into JXFS events. This is done by using a Hashtable where the key is the JXFS event parameter name and the value is the parameter value. The basic types of the J/XFS events are transformed into objects to put in the event's parameters Hashtable (type int is converted to type Integer).

For example, to get the identificationID parameter of an event:

int id = anEvent.getParameters().get("identificationID").intValue();