|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.dse.jxfsds.wosaptr.WosaPTRService
This is a J/XFS printer service which provides printer functionality based on a WOSA wrapper.
Field Summary | |
---|---|
static java.lang.String |
JXFS_COPYRIGHT
String containing the copyright for this class. |
static java.lang.String |
JXFS_VERSION_CONTROL
String containing version information for this class. |
Fields inherited from interface com.jxfs.general.JxfsConst |
---|
JXFS_ALL, JXFS_ALM_OFFSET, JXFS_CDR_OFFSET, JXFS_CHK_OFFSET, JXFS_DEP_OFFSET, JXFS_E_BUSY, JXFS_E_CANCELLED, JXFS_E_CLAIMED, JXFS_E_CLOSED, JXFS_E_DISABLED, JXFS_E_EXISTS, JXFS_E_FAILURE, JXFS_E_FIRMWARE, JXFS_E_ILLEGAL, JXFS_E_IO, JXFS_E_NOCONTROL, JXFS_E_NOEXIST, JXFS_E_NOHARDWARE, JXFS_E_NOSERVICE, JXFS_E_NOT_SUPPORTED, JXFS_E_NOTCLAIMED, JXFS_E_NOTREMOTE, JXFS_E_OFFLINE, JXFS_E_OPEN, JXFS_E_PARAMETER_INVALID, JXFS_E_REMOTE, JXFS_E_SYSTEM, JXFS_E_TIMEOUT, JXFS_E_UNREGISTERED, JXFS_FOREVER, JXFS_LEVEL_ACTIVE, JXFS_LEVEL_ALL, JXFS_LEVEL_CONFIGURED, JXFS_LEVEL_WORKSTATION, JXFS_MSD_OFFSET, JXFS_O_CLOSE, JXFS_O_OPEN, JXFS_O_UPDATEFIRMWARE, JXFS_PIN_OFFSET, JXFS_PTR_OFFSET, JXFS_RC_SUCCESSFUL, JXFS_RC_UNSUCCESSFUL, JXFS_S_BIN_STATUS, JXFS_S_CLAIMED, JXFS_S_HARDWAREERROR, JXFS_S_MEDIA_STATUS, JXFS_S_POWERSAVEOFF, JXFS_S_POWERSAVEON, JXFS_S_RELEASED, JXFS_S_REMOTEFAILURE, JXFS_S_SERVICE_STARTED, JXFS_S_SERVICE_STOPPED, JXFS_S_SHUTDOWN, JXFS_S_USERACTIONERROR, JXFS_S_WORKING, JXFS_SIU_OFFSET, JXFS_TIO_OFFSET, JXFS_VALID_CONTROLID, JXFSDEVICE_OFFSET, JXFSDIRECTIO_OFFSET, JXFSERR, JXFSERREXT, NO_MATCH, NO_SOURCE, NO_SUPPORT, OK_NEWER, OK_OLDER, OK_OTHER |
Fields inherited from interface com.jxfs.control.ptr.JxfsPrinterConst |
---|
JXFS_E_PTR_EXTEND_NOT_SUPPORTED, JXFS_E_PTR_FIELD_ERROR, JXFS_E_PTR_FIELD_GRAPHIC, JXFS_E_PTR_FIELD_HW_ERROR, JXFS_E_PTR_FIELD_INVALID, JXFS_E_PTR_FIELD_NOT_FOUND, JXFS_E_PTR_FIELD_NOT_READ, JXFS_E_PTR_FIELD_NOT_WRITE, JXFS_E_PTR_FIELD_OVERFLOW, JXFS_E_PTR_FIELD_REQUIRED, JXFS_E_PTR_FIELD_SPEC_FAILURE, JXFS_E_PTR_FIELD_STATIC_OVWR, JXFS_E_PTR_FIELD_TYPE_NOT_SUPPORTED, JXFS_E_PTR_FLUSH_FAIL, JXFS_E_PTR_FORM_INVALID, JXFS_E_PTR_FORM_NOT_FOUND, JXFS_E_PTR_MEDIA_INVALID, JXFS_E_PTR_MEDIA_NOT_FOUND, JXFS_E_PTR_MEDIA_OVERFLOW, JXFS_E_PTR_MEDIA_SKEWED, JXFS_E_PTR_MEDIA_TURN_FAIL, JXFS_E_PTR_NO_MEDIA_PRESENT, JXFS_E_PTR_NOFORMS, JXFS_E_PTR_NOMEDIA, JXFS_E_PTR_RETRACT_BIN_FULL, JXFS_I_PTR_MEDIA_INSERTED, JXFS_I_PTR_MEDIA_TAKEN, JXFS_I_PTR_NO_MEDIA_PRESENT, JXFS_O_PTR_ATP_BACKWARD, JXFS_O_PTR_ATP_FORWARD, JXFS_O_PTR_CTRL_MEDIA, JXFS_O_PTR_EJECT_MEDIA, JXFS_O_PTR_MEDIA_EXTENTS, JXFS_O_PTR_PREPARE_EJECT, JXFS_O_PTR_READ_FORM_DATA, JXFS_O_PTR_READ_IMAGE, JXFS_O_PTR_RESET_PRINTER, JXFS_O_PTR_RETRACT_MEDIA, JXFS_O_PTR_TURN_MEDIA, JXFS_O_PTR_WRITE_FORM_DATA, JXFS_O_PTR_WRITE_RAW_DATA, JXFS_PTR_ALN_BOTTOMLEFT, JXFS_PTR_ALN_BOTTOMRIGHT, JXFS_PTR_ALN_TOPLEFT, JXFS_PTR_ALN_TOPRIGHT, JXFS_PTR_ALN_USEFORMDEFN, JXFS_PTR_CTRL_ALARM, JXFS_PTR_CTRL_ATP_BACKWARD, JXFS_PTR_CTRL_ATP_FORWARD, JXFS_PTR_CTRL_CUT, JXFS_PTR_CTRL_EJECT, JXFS_PTR_CTRL_FLUSH, JXFS_PTR_CTRL_PARTIALCUT, JXFS_PTR_CTRL_PERFORATE, JXFS_PTR_CTRL_RETRACT, JXFS_PTR_CTRL_SKIP, JXFS_PTR_CTRL_STACK, JXFS_PTR_CTRL_STAMP, JXFS_PTR_CTRL_TURNMEDIA, JXFS_PTR_EXT_HORIZONTAL, JXFS_PTR_EXT_VERTICAL, JXFS_PTR_FRM_ACCESS_READ, JXFS_PTR_FRM_ACCESS_WRITE, JXFS_PTR_FRM_CLASS_OPTIONAL, JXFS_PTR_FRM_CLASS_REQUIRED, JXFS_PTR_FRM_CLASS_STATIC, JXFS_PTR_FRM_FIELD_BARCODE, JXFS_PTR_FRM_FIELD_GRAPHIC, JXFS_PTR_FRM_FIELD_MICR, JXFS_PTR_FRM_FIELD_MSF, JXFS_PTR_FRM_FIELD_OCR, JXFS_PTR_FRM_FIELD_PAGEMARK, JXFS_PTR_FRM_FIELD_TEXT, JXFS_PTR_FRM_FOLD_HORIZONTAL, JXFS_PTR_FRM_FOLD_NONE, JXFS_PTR_FRM_FOLD_VERTICAL, JXFS_PTR_FRM_INCH, JXFS_PTR_FRM_LANDSCAPE, JXFS_PTR_FRM_MEDIA_GENERIC, JXFS_PTR_FRM_MEDIA_MULTIPART, JXFS_PTR_FRM_MEDIA_PASSBOOK, JXFS_PTR_FRM_MM, JXFS_PTR_FRM_OVF_BEST_FIT, JXFS_PTR_FRM_OVF_OVERWRITE, JXFS_PTR_FRM_OVF_TERMINATE, JXFS_PTR_FRM_OVF_TRUNCATE, JXFS_PTR_FRM_OVF_WORDWRAP, JXFS_PTR_FRM_PORTRAIT, JXFS_PTR_FRM_ROWCOLUMN, JXFS_PTR_IMAGE_BMP, JXFS_PTR_IMAGE_MTF, JXFS_PTR_IMAGE_TIF, JXFS_PTR_OFFSET_USEFORMDEFN, JXFS_PTR_READ_BARCODE, JXFS_PTR_READ_IMAGE, JXFS_PTR_READ_MICR, JXFS_PTR_READ_MSF, JXFS_PTR_READ_OCR, JXFS_PTR_READ_PAGEMARK, JXFS_PTR_READ_TEXT, JXFS_PTR_WRITE_BARCODE, JXFS_PTR_WRITE_GRAPHICS, JXFS_PTR_WRITE_MICR, JXFS_PTR_WRITE_MSF, JXFS_PTR_WRITE_OCR, JXFS_PTR_WRITE_TEXT, JXFS_S_BIN_EMPTY, JXFS_S_BIN_FULL, JXFS_S_BIN_HIGH, JXFS_S_BIN_LOW, JXFS_S_BIN_NOTSUPPORTED, JXFS_S_BIN_OK, JXFS_S_BIN_UNKNOWN, JXFS_S_MEDIA_EJECTED, JXFS_S_MEDIA_JAMMED, JXFS_S_MEDIA_NOTSUPPORTED, JXFS_S_MEDIA_UNKNOWN, JXFS_S_PTR_INK, JXFS_S_PTR_LAMP, JXFS_S_PTR_LAMP_FADING, JXFS_S_PTR_LAMP_INOP, JXFS_S_PTR_LAMP_NOTSUPP, JXFS_S_PTR_LAMP_OK, JXFS_S_PTR_LAMP_UNKNOWN, JXFS_S_PTR_MEDIA, JXFS_S_PTR_PAPER, JXFS_S_PTR_RETRACT_BIN, JXFS_S_PTR_RETRACTCOUNT, JXFS_S_PTR_TONER |
Constructor Summary | |
---|---|
WosaPTRService()
This constructor creates a WosaPTRService object. |
Method Summary | |
---|---|
int |
atpBackward(int controlID)
/* atpBackward / |
int |
atpForward(int controlID)
/* atpForward / |
void |
cancel(int identification_id,
int control_id)
Cancels an operation specified by the indentificationID which is received during an asynchronous method call. |
boolean |
checkInternal()
This method is called by the QueueControl if Device Service polling is activated by calling QueueControl.checkService(...). |
boolean |
claim(int timeout,
int control_id)
Gains exclusive access to a device. |
void |
claimInternal(int control_id)
/* / |
int |
close(int control_id)
Finishes the usage of the device by this Device Control. |
void |
closeInternal(com.jxfs.forum.support.IJxfsServiceJob job)
Method is called from closeJob Method. |
void |
connectionFailure(int control_id)
Informs about a broken connection between Device Control and Service. |
int |
ctrlMedia(int mediaControl,
int controlID)
/* ctrlMedia / |
void |
deregisterControl(int control_id)
Deregisters the control at the service. |
int |
directIO(int command,
com.jxfs.general.JxfsType serializable,
int control_id)
Performs a device specific function. |
int |
ejectMedia(int mediaControl,
int controlID)
/* ejectMedia / |
void |
finalize()
Performs proper cleanup before destruction of the object. |
com.jxfs.control.ptr.JxfsPtrCtrlMediaCapability |
getCtrlMediaCapability(int controlID)
/* getCtrlMediaCapability / |
com.jxfs.control.ptr.JxfsPtrCtrlTurnCapability |
getCtrlTurnCapability(int controlID)
/* getCtrlTurnCapability / |
com.jxfs.general.JxfsVersion |
getDeviceFirmwareVersion(int control_id)
Gets the version of the current device firmware. |
com.jxfs.general.JxfsVersion |
getDeviceServiceVersion(int control_id)
Gets the version of the Device Service. |
com.jxfs.control.ptr.JxfsPtrExtentCapability |
getExtentCapability(int controlID)
/* getExtentCapability / |
int |
getFieldDescription(java.lang.String[] fieldNames,
java.lang.String formName,
int controlID)
/* getFieldDescription / |
int |
getFirmwareStatus(int control_id)
Checks the current firmware against a firmware found in the repository. |
int |
getFormDescription(java.lang.String formName,
int controlID)
/* getFormDescription / |
int |
getFormList(int controlID)
/* getFormList / |
com.jxfs.control.ptr.JxfsPtrFormsConfig |
getFormsConfig(int controlID)
/* getFormsConfig / |
com.jxfs.general.JxfsThresholdStatus |
getInkStatus(int controlID)
/* getInkStatus / |
com.jxfs.control.ptr.JxfsPtrLampStatus |
getLampStatus(int controlID)
/* getLampStatus / |
com.jxfs.control.ptr.JxfsPtrMaxRetractCapability |
getMaxRetractCapability(int controlID)
/* getMaxRetractCapability / |
com.jxfs.control.ptr.JxfsPtrMaxStackerCapability |
getMaxStackerCapability(int controlID)
/* getMaxStackerCapability / |
int |
getMediaDescription(java.lang.String mediaName,
int controlID)
/* / |
int |
getMediaList(int controlID)
/* getMediaList / |
java.lang.String |
getPhysicalDeviceDescription(int control_id)
Gets the device description. |
java.lang.String |
getPhysicalDeviceName(int control_id)
Gets the name of the physical device. |
com.jxfs.control.ptr.JxfsPtrStatus |
getPtrStatus(int controlID)
/* getPtrStatus / |
com.jxfs.control.ptr.JxfsPtrReadFormCapability |
getReadFormCapability(int controlID)
/* getReadFormCapability / |
com.jxfs.control.ptr.JxfsPtrReadImageCapability |
getReadImageCapability(int controlID)
/* getReadImageCapability / |
com.jxfs.general.JxfsVersion |
getRepositoryFirmwareVersion(int control_id)
Gets the version of the firmware found in the repository. |
com.jxfs.general.JxfsThresholdStatus |
getRetractBinStatus(int controlID)
/* getRetractBinStatus / |
com.jxfs.control.ptr.JxfsPtrRetractCount |
getRetractCount(int controlID)
/* getRetractCount / |
com.jxfs.general.JxfsStatus |
getStatus(int control_id)
Returns a copy of the current device state. |
com.jxfs.control.ptr.JxfsPtrWriteFormCapability |
getWriteFormCapability(int controlID)
/* getWriteFormCapability / |
void |
handleCmd(WOSACmdEvent event)
|
void |
handleDevEvt(WOSADevEvent event)
|
void |
initialize(com.jxfs.general.JxfsLocalDeviceInformation your_info)
This method is used by the Device Manager to deliver the detailed device information to the service. |
boolean |
isCompound(int controlID)
/* isCompound / |
boolean |
isPowerSaveModeSupported(int control_id)
Indicates if a power-save mode is supported. |
int |
mediaExtents(int controlID)
/* mediaExtents / |
int |
open(int control_id)
To be called first in order to use all other methods (except adding event listeners). |
void |
openInternal(com.jxfs.forum.support.IJxfsServiceJob job)
Method is called from openJob Method. |
int |
prepareEject(int mediaControl,
int controlID)
/* prepareEject / |
int |
printForm(java.lang.String formName,
java.lang.String mediaName,
java.lang.String[] fieldWriteData,
int controlID)
/* printForm / |
int |
printRawData(byte[] rawData,
boolean inputData,
int controlID)
/* printRawData / |
int |
readForm(java.lang.String formName,
int controlID)
/* readForm / |
int |
readImage(int controlID)
/* readImage / |
int |
registerControl(java.lang.String device_control_type,
com.jxfs.events.IJxfsEventNotification callbacks_implementing_control)
Registers an IJxfsEventNotification implementing object at the service. |
boolean |
release(int timeout,
int control_id)
Removes exclusive access to the device. |
void |
releaseInternal(int control_id)
/* / |
int |
resetPrinter(int controlID)
/* resetPrinter / |
int |
retractMedia(int mediaControl,
int controlID)
/* retractMedia / |
void |
setFormsConfig(com.jxfs.control.ptr.JxfsPtrFormsConfig formsConfig,
int controlID)
/* setFormsConfig / |
void |
setRetractCount(com.jxfs.control.ptr.JxfsPtrRetractCount rc,
int controlID)
/* setRetractCount / |
void |
shutdown()
This method is used by the Device Manager to deactivate a Device Service. |
int |
turnMedia(int controlID)
/* turnMedia / |
boolean |
updateFirmware(int control_id)
Starts updating of the firmware. |
int |
wakeUpFromPowerSave(int control_id)
Causes a device in power-save mode to return to a active state. |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String JXFS_VERSION_CONTROL
public static final java.lang.String JXFS_COPYRIGHT
Constructor Detail |
public WosaPTRService()
Method Detail |
public int atpBackward(int controlID) throws com.jxfs.events.JxfsException
atpBackward
in interface com.jxfs.service.IJxfsMediaTurnService
com.jxfs.events.JxfsException
public int atpForward(int controlID) throws com.jxfs.events.JxfsException
atpForward
in interface com.jxfs.service.IJxfsMediaTurnService
com.jxfs.events.JxfsException
public void cancel(int identification_id, int control_id) throws com.jxfs.events.JxfsException
cancel
in interface com.jxfs.service.IJxfsBaseService
identification_id
- an integer, specifies an operation to cancel that
is just in process or waiting to be processed.control_id
- an identifier for the calling Device Control.
com.jxfs.events.JxfsException
- JXFS_E_UNREGISTERED, JXFS_E_CLOSED.public boolean checkInternal()
checkInternal
in interface com.jxfs.forum.support.IQueueResponse
public boolean claim(int timeout, int control_id) throws com.jxfs.events.JxfsException
claim
in interface com.jxfs.service.IJxfsBaseService
timeout
- an integer, a timeout specified in milliseconds. The time
a application wants to wait for getting an exclusive access to the device.control_id
- an identifier for the calling Device Control.
com.jxfs.events.JxfsException
- JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_CLAIMED.public void claimInternal(int control_id)
claimInternal
in interface com.jxfs.forum.support.IQueueResponse
public int close(int control_id) throws com.jxfs.events.JxfsException
close
in interface com.jxfs.service.IJxfsBaseService
control_id
- an identifier for the calling Device Control.
com.jxfs.events.JxfsException
- JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_CLAIMED,
JXFS_E_REMOTE.public void closeInternal(com.jxfs.forum.support.IJxfsServiceJob job)
closeInternal
in interface com.jxfs.forum.support.IQueueResponse
job
- the job who has called the method
com.jxfs.events.JxfsException
public void connectionFailure(int control_id)
connectionFailure
in interface com.jxfs.service.IJxfsBaseService
control_id
- the id of the Device Control to which the connection
is broken.public int ctrlMedia(int mediaControl, int controlID) throws com.jxfs.events.JxfsException
ctrlMedia
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public void deregisterControl(int control_id) throws com.jxfs.events.JxfsException
deregisterControl
in interface com.jxfs.service.IJxfsBaseService
control_id
- an identifier for the calling Device Control.
JXFS_E_UNREGISTERED
com.jxfs.events.JxfsException
public int directIO(int command, com.jxfs.general.JxfsType serializable, int control_id) throws com.jxfs.events.JxfsException
directIO
in interface com.jxfs.service.IJxfsBaseService
command
- an identifier for a device specific operation to start.serializable
- an operation specific data object with parameters inside.control_id
- an identifier for the calling Device Control.
com.jxfs.events.JxfsException
- JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_REMOTE,
JXFS_E_CLAIMED, JXFS_E_NOHARDWARE, JXFS_E_NOT_SUPPORTED.public int ejectMedia(int mediaControl, int controlID) throws com.jxfs.events.JxfsException
ejectMedia
in interface com.jxfs.service.IJxfsEjectService
com.jxfs.events.JxfsException
public void finalize()
public com.jxfs.control.ptr.JxfsPtrCtrlMediaCapability getCtrlMediaCapability(int controlID) throws com.jxfs.events.JxfsException
getCtrlMediaCapability
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public com.jxfs.control.ptr.JxfsPtrCtrlTurnCapability getCtrlTurnCapability(int controlID) throws com.jxfs.events.JxfsException
getCtrlTurnCapability
in interface com.jxfs.service.IJxfsMediaTurnService
com.jxfs.events.JxfsException
public com.jxfs.general.JxfsVersion getDeviceFirmwareVersion(int control_id) throws com.jxfs.events.JxfsException
getDeviceFirmwareVersion
in interface com.jxfs.service.IJxfsBaseService
control_id
- an identifier for the calling Device Control.
com.jxfs.events.JxfsException
- JXFS_E_UNREGISTERED, JXFS_E_CLOSED,
JXFS_E_NOT_SUPPORTED.public com.jxfs.general.JxfsVersion getDeviceServiceVersion(int control_id) throws com.jxfs.events.JxfsException
getDeviceServiceVersion
in interface com.jxfs.service.IJxfsBaseService
control_id
- an identifier for the calling Device Control.
com.jxfs.events.JxfsException
- JXFS_E_REMOTE.public com.jxfs.control.ptr.JxfsPtrExtentCapability getExtentCapability(int controlID) throws com.jxfs.events.JxfsException
getExtentCapability
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public int getFieldDescription(java.lang.String[] fieldNames, java.lang.String formName, int controlID) throws com.jxfs.events.JxfsException
getFieldDescription
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public int getFirmwareStatus(int control_id) throws com.jxfs.events.JxfsException
getFirmwareStatus
in interface com.jxfs.service.IJxfsBaseService
control_id
- an identifier for the calling Device Control.
com.jxfs.events.JxfsException
- JXFS_E_UNREGISTERED, JXFS_E_CLOSED,
JXFS_E_NOHARDWARE.public int getFormDescription(java.lang.String formName, int controlID) throws com.jxfs.events.JxfsException
getFormDescription
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public int getFormList(int controlID) throws com.jxfs.events.JxfsException
getFormList
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public com.jxfs.control.ptr.JxfsPtrFormsConfig getFormsConfig(int controlID) throws com.jxfs.events.JxfsException
getFormsConfig
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public com.jxfs.general.JxfsThresholdStatus getInkStatus(int controlID) throws com.jxfs.events.JxfsException
getInkStatus
in interface com.jxfs.service.IJxfsEjectService
com.jxfs.events.JxfsException
public com.jxfs.control.ptr.JxfsPtrLampStatus getLampStatus(int controlID) throws com.jxfs.events.JxfsException
getLampStatus
in interface com.jxfs.service.IJxfsReadService
com.jxfs.events.JxfsException
public com.jxfs.control.ptr.JxfsPtrMaxRetractCapability getMaxRetractCapability(int controlID) throws com.jxfs.events.JxfsException
getMaxRetractCapability
in interface com.jxfs.service.IJxfsRetractService
com.jxfs.events.JxfsException
public com.jxfs.control.ptr.JxfsPtrMaxStackerCapability getMaxStackerCapability(int controlID) throws com.jxfs.events.JxfsException
getMaxStackerCapability
in interface com.jxfs.service.IJxfsEjectService
com.jxfs.events.JxfsException
public int getMediaDescription(java.lang.String mediaName, int controlID) throws com.jxfs.events.JxfsException
getMediaDescription
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public int getMediaList(int controlID) throws com.jxfs.events.JxfsException
getMediaList
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public java.lang.String getPhysicalDeviceDescription(int control_id) throws com.jxfs.events.JxfsException
getPhysicalDeviceDescription
in interface com.jxfs.service.IJxfsBaseService
control_id
- an identifier for the calling Device Control.
com.jxfs.events.JxfsException
- JXFS_E_UNREGISTERED, JXFS_E_CLOSED,
JXFS_E_NOHARDWARE.public java.lang.String getPhysicalDeviceName(int control_id) throws com.jxfs.events.JxfsException
getPhysicalDeviceName
in interface com.jxfs.service.IJxfsBaseService
control_id
- an identifier for the calling Device Control.
com.jxfs.events.JxfsException
- JXFS_E_CLOSED,,
JXFS_E_NOHARDWARE.public com.jxfs.control.ptr.JxfsPtrStatus getPtrStatus(int controlID) throws com.jxfs.events.JxfsException
getPtrStatus
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public com.jxfs.control.ptr.JxfsPtrReadFormCapability getReadFormCapability(int controlID) throws com.jxfs.events.JxfsException
getReadFormCapability
in interface com.jxfs.service.IJxfsReadService
com.jxfs.events.JxfsException
public com.jxfs.control.ptr.JxfsPtrReadImageCapability getReadImageCapability(int controlID) throws com.jxfs.events.JxfsException
getReadImageCapability
in interface com.jxfs.service.IJxfsReadService
com.jxfs.events.JxfsException
public com.jxfs.general.JxfsVersion getRepositoryFirmwareVersion(int control_id) throws com.jxfs.events.JxfsException
getRepositoryFirmwareVersion
in interface com.jxfs.service.IJxfsBaseService
control_id
- an identifier for the calling Device Control.
com.jxfs.events.JxfsException
- JXFS_E_UNREGISTERED, JXFS_E_CLOSED,
JXFS_E_NOT_SUPPORTED.public com.jxfs.general.JxfsThresholdStatus getRetractBinStatus(int controlID) throws com.jxfs.events.JxfsException
getRetractBinStatus
in interface com.jxfs.service.IJxfsRetractService
com.jxfs.events.JxfsException
public com.jxfs.control.ptr.JxfsPtrRetractCount getRetractCount(int controlID) throws com.jxfs.events.JxfsException
getRetractCount
in interface com.jxfs.service.IJxfsRetractService
com.jxfs.events.JxfsException
public com.jxfs.general.JxfsStatus getStatus(int control_id) throws com.jxfs.events.JxfsException
getStatus
in interface com.jxfs.service.IJxfsBaseService
control_id
- an identifier for the calling Device Control.
com.jxfs.events.JxfsException
- JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_REMOTE.public com.jxfs.control.ptr.JxfsPtrWriteFormCapability getWriteFormCapability(int controlID) throws com.jxfs.events.JxfsException
getWriteFormCapability
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public void handleCmd(WOSACmdEvent event)
handleCmd
in interface WOSACmdListener
event
- WOSACmdEventpublic void handleDevEvt(WOSADevEvent event)
handleDevEvt
in interface WOSADevListener
event
- WOSADevEventpublic void initialize(com.jxfs.general.JxfsLocalDeviceInformation your_info) throws com.jxfs.events.JxfsException
initialize
in interface com.jxfs.service.IJxfsBaseService
your_info
- the Device Information.
com.jxfs.events.JxfsException
- JXFS_E_REMOTE - in case of unsuccessful lookup
performed by the client side of the communication layer.public boolean isCompound(int controlID) throws com.jxfs.events.JxfsException
isCompound
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public boolean isPowerSaveModeSupported(int control_id) throws com.jxfs.events.JxfsException
isPowerSaveModeSupported
in interface com.jxfs.service.IJxfsBaseService
control_id
- an identifier for the calling Device Control.
com.jxfs.events.JxfsException
- JXFS_E_UNREGISTERED, JXFS_E_CLOSED.public int mediaExtents(int controlID) throws com.jxfs.events.JxfsException
mediaExtents
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public int open(int control_id) throws com.jxfs.events.JxfsException
open
in interface com.jxfs.service.IJxfsBaseService
control_id
- an identifier for the calling Device Control.
com.jxfs.events.JxfsException
- JXFS_E_UNREGISTERED, JXFS_E_OPEN.public void openInternal(com.jxfs.forum.support.IJxfsServiceJob job) throws com.jxfs.events.JxfsException
openInternal
in interface com.jxfs.forum.support.IQueueResponse
job
- the job who has called the method
com.jxfs.events.JxfsException
public int prepareEject(int mediaControl, int controlID) throws com.jxfs.events.JxfsException
prepareEject
in interface com.jxfs.service.IJxfsEjectService
com.jxfs.events.JxfsException
public int printForm(java.lang.String formName, java.lang.String mediaName, java.lang.String[] fieldWriteData, int controlID) throws com.jxfs.events.JxfsException
printForm
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public int printRawData(byte[] rawData, boolean inputData, int controlID) throws com.jxfs.events.JxfsException
printRawData
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public int readForm(java.lang.String formName, int controlID) throws com.jxfs.events.JxfsException
readForm
in interface com.jxfs.service.IJxfsReadService
com.jxfs.events.JxfsException
public int readImage(int controlID) throws com.jxfs.events.JxfsException
readImage
in interface com.jxfs.service.IJxfsReadService
com.jxfs.events.JxfsException
public int registerControl(java.lang.String device_control_type, com.jxfs.events.IJxfsEventNotification callbacks_implementing_control) throws com.jxfs.events.JxfsException
registerControl
in interface com.jxfs.service.IJxfsBaseService
device_control_type
- the name of the Device Control type.
com.jxfs.events.JxfsException
- JXFS_E_REMOTE - in case of network error.public boolean release(int timeout, int control_id) throws com.jxfs.events.JxfsException
release
in interface com.jxfs.service.IJxfsBaseService
timeout
- an integer, a timeout specified in milliseconds. The time
a application wants to wait for removing an exclusive access to the device.control_id
- an identifier for the calling Device Control.
com.jxfs.events.JxfsException
- JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_NOTCLAIMED.public void releaseInternal(int control_id)
releaseInternal
in interface com.jxfs.forum.support.IQueueResponse
public int resetPrinter(int controlID) throws com.jxfs.events.JxfsException
resetPrinter
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public int retractMedia(int mediaControl, int controlID) throws com.jxfs.events.JxfsException
retractMedia
in interface com.jxfs.service.IJxfsRetractService
com.jxfs.events.JxfsException
public void setFormsConfig(com.jxfs.control.ptr.JxfsPtrFormsConfig formsConfig, int controlID) throws com.jxfs.events.JxfsException
setFormsConfig
in interface com.jxfs.service.IJxfsPrinterService
com.jxfs.events.JxfsException
public void setRetractCount(com.jxfs.control.ptr.JxfsPtrRetractCount rc, int controlID) throws com.jxfs.events.JxfsException
setRetractCount
in interface com.jxfs.service.IJxfsRetractService
com.jxfs.events.JxfsException
public void shutdown() throws com.jxfs.events.JxfsException
shutdown
in interface com.jxfs.service.IJxfsBaseService
com.jxfs.events.JxfsException
- common exceptions.public int turnMedia(int controlID) throws com.jxfs.events.JxfsException
turnMedia
in interface com.jxfs.service.IJxfsMediaTurnService
com.jxfs.events.JxfsException
public boolean updateFirmware(int control_id) throws com.jxfs.events.JxfsException
updateFirmware
in interface com.jxfs.service.IJxfsBaseService
control_id
- an identifier for the calling Device Control.
com.jxfs.events.JxfsException
- JXFS_E_UNREGISTERED, JXFS_E_CLOSED,
JXFS_E_NOHARDWARE, JXFS_E_FIRMWARE, JXFS_E_NOT_SUPPORTED.public int wakeUpFromPowerSave(int control_id) throws com.jxfs.events.JxfsException
wakeUpFromPowerSave
in interface com.jxfs.service.IJxfsBaseService
control_id
- an identifier for the calling Device Control.
com.jxfs.events.JxfsException
- JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_REMOTE.
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |