IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.jxfsds.wosaptr
Class WosaPTRService

java.lang.Object
  extended bycom.ibm.dse.jxfsds.wosaptr.WosaPTRService
All Implemented Interfaces:
java.util.EventListener, com.jxfs.service.IJxfsBaseService, com.jxfs.service.IJxfsEjectService, com.jxfs.service.IJxfsMediaTurnService, com.jxfs.service.IJxfsPrinterService, com.jxfs.service.IJxfsReadService, com.jxfs.service.IJxfsRetractService, com.jxfs.forum.support.IQueueResponse, com.jxfs.general.JxfsConst, com.jxfs.control.ptr.JxfsPrinterConst, WOSACmdListener, WOSAConst, WOSADevListener, WOSAPtrConst

public class WosaPTRService
extends java.lang.Object
implements com.jxfs.general.JxfsConst, com.jxfs.control.ptr.JxfsPrinterConst, com.jxfs.service.IJxfsPrinterService, com.jxfs.service.IJxfsEjectService, com.jxfs.service.IJxfsRetractService, com.jxfs.service.IJxfsMediaTurnService, com.jxfs.service.IJxfsReadService, com.jxfs.forum.support.IQueueResponse, WOSAConst, WOSAPtrConst, WOSACmdListener, WOSADevListener

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
 
Fields inherited from interface com.ibm.dse.wosabean.WOSAConst
EXECUTE_EVENTS, SERVICE_EVENTS, SYSTEM_EVENTS, USER_EVENTS, WFS_CLOSE_COMPLETE, WFS_DEREGISTER_COMPLETE, WFS_ERR_ALREADY_STARTED, WFS_ERR_API_VER_TOO_HIGH, WFS_ERR_API_VER_TOO_LOW, WFS_ERR_CANCELED, WFS_ERR_CFG_INVALID_HKEY, WFS_ERR_CFG_INVALID_NAME, WFS_ERR_CFG_INVALID_SUBKEY, WFS_ERR_CFG_INVALID_VALUE, WFS_ERR_CFG_KEY_NOT_EMPTY, WFS_ERR_CFG_NAME_TOO_LONG, WFS_ERR_CFG_NO_MORE_ITEMS, WFS_ERR_CFG_VALUE_TOO_LONG, WFS_ERR_CONNECTION_LOST, WFS_ERR_DEV_NOT_READY, WFS_ERR_HARDWARE_ERROR, WFS_ERR_INTERNAL_ERROR, WFS_ERR_INVALID_ADDRESS, WFS_ERR_INVALID_APP_HANDLE, WFS_ERR_INVALID_BUFFER, WFS_ERR_INVALID_CATEGORY, WFS_ERR_INVALID_COMMAND, WFS_ERR_INVALID_DATA, WFS_ERR_INVALID_EVENT_CLASS, WFS_ERR_INVALID_HPROVIDER, WFS_ERR_INVALID_HSERVICE, WFS_ERR_INVALID_HWND, WFS_ERR_INVALID_HWNDREG, WFS_ERR_INVALID_POINTER, WFS_ERR_INVALID_REQ_ID, WFS_ERR_INVALID_RESULT, WFS_ERR_INVALID_SERVPROV, WFS_ERR_INVALID_TIMER, WFS_ERR_INVALID_TRACELEVEL, WFS_ERR_LOCKED, WFS_ERR_NO_BLOCKING_CALL, WFS_ERR_NO_SERVPROV, WFS_ERR_NO_SUCH_THREAD, WFS_ERR_NO_TIMER, WFS_ERR_NOT_LOCKED, WFS_ERR_NOT_OK_TO_UNLOAD, WFS_ERR_NOT_REGISTERED, WFS_ERR_NOT_STARTED, WFS_ERR_OP_IN_PROGRESS, WFS_ERR_OUT_OF_MEMORY, WFS_ERR_SERVICE_NOT_FOUND, WFS_ERR_SOFTWARE_ERROR, WFS_ERR_SPI_VER_TOO_HIGH, WFS_ERR_SPI_VER_TOO_LOW, WFS_ERR_SRVC_VER_TOO_HIGH, WFS_ERR_SRVC_VER_TOO_LOW, WFS_ERR_TIMEOUT, WFS_ERR_UNSUPP_CATEGORY, WFS_ERR_UNSUPP_COMMAND, WFS_ERR_VERSION_ERROR_IN_SRVC, WFS_EXECUTE_COMPLETE, WFS_EXECUTE_EVENT, WFS_GETINFO_COMPLETE, WFS_INDEFINITE_WAIT, WFS_LOCK_COMPLETE, WFS_OPEN_COMPLETE, WFS_REGISTER_COMPLETE, WFS_SERVICE_EVENT, WFS_STAT_DEVBUSY, WFS_STAT_DEVHWERROR, WFS_STAT_DEVNODEVICE, WFS_STAT_DEVOFFLINE, WFS_STAT_DEVONLINE, WFS_STAT_DEVPOWEROFF, WFS_STAT_DEVUSERERROR, WFS_SUCCESS, WFS_SYSE_APP_DISCONNECT, WFS_SYSE_DEVICE_STATUS, WFS_SYSE_HARDWARE_ERROR, WFS_SYSE_UNDELIVERABLE_MSG, WFS_SYSE_VERSION_ERROR, WFS_SYSTEM_EVENT, WFS_TIMER_EVENT, WFS_TRACE_ALL_API, WFS_TRACE_ALL_SPI, WFS_TRACE_API, WFS_TRACE_MGR, WFS_TRACE_SPI, WFS_UNLOCK_COMPLETE, WFS_USER_EVENT
 
Fields inherited from interface com.ibm.dse.wosabean.WOSAPtrConst
WFS_CMD_PTR_CONTROL_MEDIA, WFS_CMD_PTR_MEDIA_EXTENTS, WFS_CMD_PTR_PRINT_FORM, WFS_CMD_PTR_RAW_DATA, WFS_CMD_PTR_READ_FORM, WFS_CMD_PTR_READ_IMAGE, WFS_CMD_PTR_RESET_COUNT, WFS_ERR_PTR_EXTENTNOTSUPPORTED, WFS_ERR_PTR_FIELDERROR, WFS_ERR_PTR_FIELDINVALID, WFS_ERR_PTR_FIELDNOTFOUND, WFS_ERR_PTR_FIELDSPECFAILURE, WFS_ERR_PTR_FLUSHFAIL, WFS_ERR_PTR_FORMINVALID, WFS_ERR_PTR_FORMNOTFOUND, WFS_ERR_PTR_MEDIAINVALID, WFS_ERR_PTR_MEDIANOTFOUND, WFS_ERR_PTR_MEDIAOVERFLOW, WFS_ERR_PTR_MEDIASKEWED, WFS_ERR_PTR_MEDIATURNFAIL, WFS_ERR_PTR_NOMEDIAPRESENT, WFS_ERR_PTR_PAGETURNFAIL, WFS_ERR_PTR_READNOTSUPPORTED, WFS_ERR_PTR_RETRACTBINFULL, WFS_ERR_PTR_STACKERFULL, WFS_EXEE_PTR_FIELDERROR, WFS_EXEE_PTR_FIELDWARNING, WFS_EXEE_PTR_MEDIAINSERTED, WFS_EXEE_PTR_NOMEDIA, WFS_FRM_ACCESSREAD, WFS_FRM_ACCESSWRITE, WFS_FRM_BOTTOMLEFT, WFS_FRM_BOTTOMRIGHT, WFS_FRM_CLASSOPTIONAL, WFS_FRM_CLASSREQUIRED, WFS_FRM_CLASSSTATIC, WFS_FRM_FIELDBARCODE, WFS_FRM_FIELDGRAPHIC, WFS_FRM_FIELDMICR, WFS_FRM_FIELDMSF, WFS_FRM_FIELDOCR, WFS_FRM_FIELDPAGEMARK, WFS_FRM_FIELDTEXT, WFS_FRM_FOLDHORIZONTAL, WFS_FRM_FOLDNONE, WFS_FRM_FOLDVERTICAL, WFS_FRM_INCH, WFS_FRM_LANDSCAPE, WFS_FRM_MEDIAGENERIC, WFS_FRM_MEDIAMULTIPART, WFS_FRM_MEDIAPASSBOOK, WFS_FRM_MM, WFS_FRM_OVFBESTFIT, WFS_FRM_OVFOVERWRITE, WFS_FRM_OVFTERMINATE, WFS_FRM_OVFTRUNCATE, WFS_FRM_OVFWORDWRAP, WFS_FRM_PORTRAIT, WFS_FRM_ROWCOLUMN, WFS_FRM_TOPLEFT, WFS_FRM_TOPRIGHT, WFS_INF_PTR_CAPABILITIES, WFS_INF_PTR_FORM_LIST, WFS_INF_PTR_MEDIA_LIST, WFS_INF_PTR_QUERY_FIELD, WFS_INF_PTR_QUERY_FORM, WFS_INF_PTR_QUERY_MEDIA, WFS_INF_PTR_STATUS, WFS_PTR_ALNBOTTOMLEFT, WFS_PTR_ALNBOTTOMRIGHT, WFS_PTR_ALNTOPLEFT, WFS_PTR_ALNTOPRIGHT, WFS_PTR_ALNUSEFORMDEFN, WFS_PTR_CTRLALARM, WFS_PTR_CTRLATPBACKWARD, WFS_PTR_CTRLATPFORWARD, WFS_PTR_CTRLCUT, WFS_PTR_CTRLEJECT, WFS_PTR_CTRLFLUSH, WFS_PTR_CTRLPARTIALCUT, WFS_PTR_CTRLPERFORATE, WFS_PTR_CTRLRETRACT, WFS_PTR_CTRLSKIP, WFS_PTR_CTRLSTACK, WFS_PTR_CTRLSTAMP, WFS_PTR_CTRLTURNMEDIA, WFS_PTR_EXTHORIZONTAL, WFS_PTR_EXTVERTICAL, WFS_PTR_FIELDGRAPHIC, WFS_PTR_FIELDHWERROR, WFS_PTR_FIELDNOTFOUND, WFS_PTR_FIELDNOTREAD, WFS_PTR_FIELDNOTWRITE, WFS_PTR_FIELDOVERFLOW, WFS_PTR_FIELDREQUIRED, WFS_PTR_FIELDSTATICOVWR, WFS_PTR_FIELDTYPENOTSUPPORTED, WFS_PTR_IMAGEBMP, WFS_PTR_IMAGEMTF, WFS_PTR_IMAGETIF, WFS_PTR_INKFULL, WFS_PTR_INKLOW, WFS_PTR_INKNOTSUPP, WFS_PTR_INKOUT, WFS_PTR_INKUNKNOWN, WFS_PTR_INPUTDATA, WFS_PTR_LAMPFADING, WFS_PTR_LAMPINOP, WFS_PTR_LAMPNOTSUPP, WFS_PTR_LAMPOK, WFS_PTR_LAMPUNKNOWN, WFS_PTR_MEDIAENTERING, WFS_PTR_MEDIAJAMMED, WFS_PTR_MEDIANOTPRESENT, WFS_PTR_MEDIANOTSUPP, WFS_PTR_MEDIAPRESENT, WFS_PTR_MEDIAUNKNOWN, WFS_PTR_NOINPUTDATA, WFS_PTR_OFFSETUSEFORMDEFN, WFS_PTR_PAPERFULL, WFS_PTR_PAPERLOW, WFS_PTR_PAPERNOTSUPP, WFS_PTR_PAPEROUT, WFS_PTR_PAPERUNKNOWN, WFS_PTR_READBARCODE, WFS_PTR_READIMAGE, WFS_PTR_READMICR, WFS_PTR_READMSF, WFS_PTR_READOCR, WFS_PTR_READPAGEMARK, WFS_PTR_RESHIGH, WFS_PTR_RESLOW, WFS_PTR_RESMED, WFS_PTR_RESVERYHIGH, WFS_PTR_RETRACTBINFULL, WFS_PTR_RETRACTBINHIGH, WFS_PTR_RETRACTBINOK, WFS_PTR_RETRACTNOTSUPP, WFS_PTR_RETRACTUNKNOWN, WFS_PTR_TONERFULL, WFS_PTR_TONERLOW, WFS_PTR_TONERNOTSUPP, WFS_PTR_TONEROUT, WFS_PTR_TONERUNKNOWN, WFS_PTR_TYPEDOCUMENT, WFS_PTR_TYPEJOURNAL, WFS_PTR_TYPEPASSBOOK, WFS_PTR_TYPERECEIPT, WFS_PTR_WRITEBARCODE, WFS_PTR_WRITEGRAPHICS, WFS_PTR_WRITEMICR, WFS_PTR_WRITEMSF, WFS_PTR_WRITEOCR, WFS_PTR_WRITESTAMP, WFS_PTR_WRITETEXT, WFS_SRVE_PTR_MEDIAINSERTED, WFS_SRVE_PTR_MEDIATAKEN, WFS_USRE_PTR_PAPERTHRESHOLD, WFS_USRE_PTR_RETRACTBINTHRESHOLD, WFS_USRE_PTR_TONERTHRESHOLD
 
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

JXFS_VERSION_CONTROL

public static final java.lang.String JXFS_VERSION_CONTROL
String containing version information for this class. This String holds the following values :

See Also:
Constant Field Values

JXFS_COPYRIGHT

public static final java.lang.String JXFS_COPYRIGHT
String containing the copyright for this class.

See Also:
Constant Field Values
Constructor Detail

WosaPTRService

public WosaPTRService()
This constructor creates a WosaPTRService object.

Method Detail

atpBackward

public int atpBackward(int controlID)
                throws com.jxfs.events.JxfsException
/* atpBackward /

Specified by:
atpBackward in interface com.jxfs.service.IJxfsMediaTurnService
Throws:
com.jxfs.events.JxfsException

atpForward

public int atpForward(int controlID)
               throws com.jxfs.events.JxfsException
/* atpForward /

Specified by:
atpForward in interface com.jxfs.service.IJxfsMediaTurnService
Throws:
com.jxfs.events.JxfsException

cancel

public void cancel(int identification_id,
                   int control_id)
            throws com.jxfs.events.JxfsException
Cancels an operation specified by the indentificationID which is received during an asynchronous method call.

Specified by:
cancel in interface com.jxfs.service.IJxfsBaseService
Parameters:
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.
Throws:
com.jxfs.events.JxfsException - JXFS_E_UNREGISTERED, JXFS_E_CLOSED.

checkInternal

public boolean checkInternal()
This method is called by the QueueControl if Device Service polling is activated by calling QueueControl.checkService(...). Use checkInternal() for instance to check the status of the device.

Specified by:
checkInternal in interface com.jxfs.forum.support.IQueueResponse
Returns:
true - if the Device Service has to be called again, false otherwise.

claim

public boolean claim(int timeout,
                     int control_id)
              throws com.jxfs.events.JxfsException
Gains exclusive access to a device. This is a synchronous call.

Specified by:
claim in interface com.jxfs.service.IJxfsBaseService
Parameters:
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.
Returns:
boolean - true if successful, false otherwise.
Throws:
com.jxfs.events.JxfsException - JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_CLAIMED.

claimInternal

public void claimInternal(int control_id)
/* /

Specified by:
claimInternal in interface com.jxfs.forum.support.IQueueResponse

close

public int close(int control_id)
          throws com.jxfs.events.JxfsException
Finishes the usage of the device by this Device Control. If only one control has an open state its close causes a physical close of the device.

Specified by:
close in interface com.jxfs.service.IJxfsBaseService
Parameters:
control_id - an identifier for the calling Device Control.
Returns:
int - an identification_id for this asynchronous call.
Throws:
com.jxfs.events.JxfsException - JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_CLAIMED, JXFS_E_REMOTE.

closeInternal

public void closeInternal(com.jxfs.forum.support.IJxfsServiceJob job)
Method is called from closeJob Method. This method counts down the open counter. If this was the last close call, the device will be finalized physically.

Specified by:
closeInternal in interface com.jxfs.forum.support.IQueueResponse
Parameters:
job - the job who has called the method
Throws:
com.jxfs.events.JxfsException

connectionFailure

public void connectionFailure(int control_id)
Informs about a broken connection between Device Control and Service. Called by the communication layer in case of a network error that is not detected during a call caused by this object. The Device Service will deregister the specified Device Control.

Specified by:
connectionFailure in interface com.jxfs.service.IJxfsBaseService
Parameters:
control_id - the id of the Device Control to which the connection is broken.

ctrlMedia

public int ctrlMedia(int mediaControl,
                     int controlID)
              throws com.jxfs.events.JxfsException
/* ctrlMedia /

Specified by:
ctrlMedia in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

deregisterControl

public void deregisterControl(int control_id)
                       throws com.jxfs.events.JxfsException
Deregisters the control at the service.

Specified by:
deregisterControl in interface com.jxfs.service.IJxfsBaseService
Parameters:
control_id - an identifier for the calling Device Control.
Throws:
JXFS_E_UNREGISTERED
com.jxfs.events.JxfsException

directIO

public int directIO(int command,
                    com.jxfs.general.JxfsType serializable,
                    int control_id)
             throws com.jxfs.events.JxfsException
Performs a device specific function.

Specified by:
directIO in interface com.jxfs.service.IJxfsBaseService
Parameters:
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.
Returns:
an identification_id for this asynchronous call.
Throws:
com.jxfs.events.JxfsException - JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_REMOTE, JXFS_E_CLAIMED, JXFS_E_NOHARDWARE, JXFS_E_NOT_SUPPORTED.

ejectMedia

public int ejectMedia(int mediaControl,
                      int controlID)
               throws com.jxfs.events.JxfsException
/* ejectMedia /

Specified by:
ejectMedia in interface com.jxfs.service.IJxfsEjectService
Throws:
com.jxfs.events.JxfsException

finalize

public void finalize()
Performs proper cleanup before destruction of the object. This method overwrites Object.finalize();


getCtrlMediaCapability

public com.jxfs.control.ptr.JxfsPtrCtrlMediaCapability getCtrlMediaCapability(int controlID)
                                                                       throws com.jxfs.events.JxfsException
/* getCtrlMediaCapability /

Specified by:
getCtrlMediaCapability in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

getCtrlTurnCapability

public com.jxfs.control.ptr.JxfsPtrCtrlTurnCapability getCtrlTurnCapability(int controlID)
                                                                     throws com.jxfs.events.JxfsException
/* getCtrlTurnCapability /

Specified by:
getCtrlTurnCapability in interface com.jxfs.service.IJxfsMediaTurnService
Throws:
com.jxfs.events.JxfsException

getDeviceFirmwareVersion

public com.jxfs.general.JxfsVersion getDeviceFirmwareVersion(int control_id)
                                                      throws com.jxfs.events.JxfsException
Gets the version of the current device firmware.

Specified by:
getDeviceFirmwareVersion in interface com.jxfs.service.IJxfsBaseService
Parameters:
control_id - an identifier for the calling Device Control.
Returns:
JxfsVersion - the version information.
Throws:
com.jxfs.events.JxfsException - JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_NOT_SUPPORTED.

getDeviceServiceVersion

public com.jxfs.general.JxfsVersion getDeviceServiceVersion(int control_id)
                                                     throws com.jxfs.events.JxfsException
Gets the version of the Device Service.

Specified by:
getDeviceServiceVersion in interface com.jxfs.service.IJxfsBaseService
Parameters:
control_id - an identifier for the calling Device Control.
Returns:
JxfsVersion - contains the version information.
Throws:
com.jxfs.events.JxfsException - JXFS_E_REMOTE.

getExtentCapability

public com.jxfs.control.ptr.JxfsPtrExtentCapability getExtentCapability(int controlID)
                                                                 throws com.jxfs.events.JxfsException
/* getExtentCapability /

Specified by:
getExtentCapability in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

getFieldDescription

public int getFieldDescription(java.lang.String[] fieldNames,
                               java.lang.String formName,
                               int controlID)
                        throws com.jxfs.events.JxfsException
/* getFieldDescription /

Specified by:
getFieldDescription in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

getFirmwareStatus

public int getFirmwareStatus(int control_id)
                      throws com.jxfs.events.JxfsException
Checks the current firmware against a firmware found in the repository.

Specified by:
getFirmwareStatus in interface com.jxfs.service.IJxfsBaseService
Parameters:
control_id - an identifier for the calling Device Control.
Returns:
int OK_NEWER - firmware in repository is newer than current firmware; OK_OLDER - current firmware is newer but update possible; OK_OTHER - different firmware functionality but update possible; NO_SOURCE - no firmware found in the repository; NO_MATCH - firmware in the repository is not correct for this device; NO_SUPPORT - firmware update is not possible with this device.
Throws:
com.jxfs.events.JxfsException - JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_NOHARDWARE.

getFormDescription

public int getFormDescription(java.lang.String formName,
                              int controlID)
                       throws com.jxfs.events.JxfsException
/* getFormDescription /

Specified by:
getFormDescription in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

getFormList

public int getFormList(int controlID)
                throws com.jxfs.events.JxfsException
/* getFormList /

Specified by:
getFormList in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

getFormsConfig

public com.jxfs.control.ptr.JxfsPtrFormsConfig getFormsConfig(int controlID)
                                                       throws com.jxfs.events.JxfsException
/* getFormsConfig /

Specified by:
getFormsConfig in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

getInkStatus

public com.jxfs.general.JxfsThresholdStatus getInkStatus(int controlID)
                                                  throws com.jxfs.events.JxfsException
/* getInkStatus /

Specified by:
getInkStatus in interface com.jxfs.service.IJxfsEjectService
Throws:
com.jxfs.events.JxfsException

getLampStatus

public com.jxfs.control.ptr.JxfsPtrLampStatus getLampStatus(int controlID)
                                                     throws com.jxfs.events.JxfsException
/* getLampStatus /

Specified by:
getLampStatus in interface com.jxfs.service.IJxfsReadService
Throws:
com.jxfs.events.JxfsException

getMaxRetractCapability

public com.jxfs.control.ptr.JxfsPtrMaxRetractCapability getMaxRetractCapability(int controlID)
                                                                         throws com.jxfs.events.JxfsException
/* getMaxRetractCapability /

Specified by:
getMaxRetractCapability in interface com.jxfs.service.IJxfsRetractService
Throws:
com.jxfs.events.JxfsException

getMaxStackerCapability

public com.jxfs.control.ptr.JxfsPtrMaxStackerCapability getMaxStackerCapability(int controlID)
                                                                         throws com.jxfs.events.JxfsException
/* getMaxStackerCapability /

Specified by:
getMaxStackerCapability in interface com.jxfs.service.IJxfsEjectService
Throws:
com.jxfs.events.JxfsException

getMediaDescription

public int getMediaDescription(java.lang.String mediaName,
                               int controlID)
                        throws com.jxfs.events.JxfsException
/* /

Specified by:
getMediaDescription in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

getMediaList

public int getMediaList(int controlID)
                 throws com.jxfs.events.JxfsException
/* getMediaList /

Specified by:
getMediaList in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

getPhysicalDeviceDescription

public java.lang.String getPhysicalDeviceDescription(int control_id)
                                              throws com.jxfs.events.JxfsException
Gets the device description.

Specified by:
getPhysicalDeviceDescription in interface com.jxfs.service.IJxfsBaseService
Parameters:
control_id - an identifier for the calling Device Control.
Returns:
String - the device description.
Throws:
com.jxfs.events.JxfsException - JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_NOHARDWARE.

getPhysicalDeviceName

public java.lang.String getPhysicalDeviceName(int control_id)
                                       throws com.jxfs.events.JxfsException
Gets the name of the physical device.

Specified by:
getPhysicalDeviceName in interface com.jxfs.service.IJxfsBaseService
Parameters:
control_id - an identifier for the calling Device Control.
Returns:
String - the device name.
Throws:
com.jxfs.events.JxfsException - JXFS_E_CLOSED,, JXFS_E_NOHARDWARE.

getPtrStatus

public com.jxfs.control.ptr.JxfsPtrStatus getPtrStatus(int controlID)
                                                throws com.jxfs.events.JxfsException
/* getPtrStatus /

Specified by:
getPtrStatus in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

getReadFormCapability

public com.jxfs.control.ptr.JxfsPtrReadFormCapability getReadFormCapability(int controlID)
                                                                     throws com.jxfs.events.JxfsException
/* getReadFormCapability /

Specified by:
getReadFormCapability in interface com.jxfs.service.IJxfsReadService
Throws:
com.jxfs.events.JxfsException

getReadImageCapability

public com.jxfs.control.ptr.JxfsPtrReadImageCapability getReadImageCapability(int controlID)
                                                                       throws com.jxfs.events.JxfsException
/* getReadImageCapability /

Specified by:
getReadImageCapability in interface com.jxfs.service.IJxfsReadService
Throws:
com.jxfs.events.JxfsException

getRepositoryFirmwareVersion

public com.jxfs.general.JxfsVersion getRepositoryFirmwareVersion(int control_id)
                                                          throws com.jxfs.events.JxfsException
Gets the version of the firmware found in the repository.

Specified by:
getRepositoryFirmwareVersion in interface com.jxfs.service.IJxfsBaseService
Parameters:
control_id - an identifier for the calling Device Control.
Returns:
JxfsVersion - the version information.
Throws:
com.jxfs.events.JxfsException - JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_NOT_SUPPORTED.

getRetractBinStatus

public com.jxfs.general.JxfsThresholdStatus getRetractBinStatus(int controlID)
                                                         throws com.jxfs.events.JxfsException
/* getRetractBinStatus /

Specified by:
getRetractBinStatus in interface com.jxfs.service.IJxfsRetractService
Throws:
com.jxfs.events.JxfsException

getRetractCount

public com.jxfs.control.ptr.JxfsPtrRetractCount getRetractCount(int controlID)
                                                         throws com.jxfs.events.JxfsException
/* getRetractCount /

Specified by:
getRetractCount in interface com.jxfs.service.IJxfsRetractService
Throws:
com.jxfs.events.JxfsException

getStatus

public com.jxfs.general.JxfsStatus getStatus(int control_id)
                                      throws com.jxfs.events.JxfsException
Returns a copy of the current device state.

Specified by:
getStatus in interface com.jxfs.service.IJxfsBaseService
Parameters:
control_id - an identifier for the calling Device Control.
Returns:
JxfsStatus - an object which is a clone of the original JxfsStatus object maintained by the Device Service. So, actuality of the delivered information is a matter of time.
Throws:
com.jxfs.events.JxfsException - JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_REMOTE.

getWriteFormCapability

public com.jxfs.control.ptr.JxfsPtrWriteFormCapability getWriteFormCapability(int controlID)
                                                                       throws com.jxfs.events.JxfsException
/* getWriteFormCapability /

Specified by:
getWriteFormCapability in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

handleCmd

public void handleCmd(WOSACmdEvent event)
Specified by:
handleCmd in interface WOSACmdListener
Parameters:
event - WOSACmdEvent

handleDevEvt

public void handleDevEvt(WOSADevEvent event)
Specified by:
handleDevEvt in interface WOSADevListener
Parameters:
event - WOSADevEvent

initialize

public void initialize(com.jxfs.general.JxfsLocalDeviceInformation your_info)
                throws com.jxfs.events.JxfsException
This method is used by the Device Manager to deliver the detailed device information to the service.

Specified by:
initialize in interface com.jxfs.service.IJxfsBaseService
Parameters:
your_info - the Device Information.
Throws:
com.jxfs.events.JxfsException - JXFS_E_REMOTE - in case of unsuccessful lookup performed by the client side of the communication layer.

isCompound

public boolean isCompound(int controlID)
                   throws com.jxfs.events.JxfsException
/* isCompound /

Specified by:
isCompound in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

isPowerSaveModeSupported

public boolean isPowerSaveModeSupported(int control_id)
                                 throws com.jxfs.events.JxfsException
Indicates if a power-save mode is supported.

Specified by:
isPowerSaveModeSupported in interface com.jxfs.service.IJxfsBaseService
Parameters:
control_id - an identifier for the calling Device Control.
Returns:
boolean true, if supported.
Throws:
com.jxfs.events.JxfsException - JXFS_E_UNREGISTERED, JXFS_E_CLOSED.

mediaExtents

public int mediaExtents(int controlID)
                 throws com.jxfs.events.JxfsException
/* mediaExtents /

Specified by:
mediaExtents in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

open

public int open(int control_id)
         throws com.jxfs.events.JxfsException
To be called first in order to use all other methods (except adding event listeners). The first open a Device Service receives from a Device Control causes a physical initialization of the device.

Specified by:
open in interface com.jxfs.service.IJxfsBaseService
Parameters:
control_id - an identifier for the calling Device Control.
Returns:
int - an identification_id for this asynchronous call.
Throws:
com.jxfs.events.JxfsException - JXFS_E_UNREGISTERED, JXFS_E_OPEN.

openInternal

public void openInternal(com.jxfs.forum.support.IJxfsServiceJob job)
                  throws com.jxfs.events.JxfsException
Method is called from openJob Method. This method counts the open counter. If this was the first open call, the device will be initialized physically.

Specified by:
openInternal in interface com.jxfs.forum.support.IQueueResponse
Parameters:
job - the job who has called the method
Throws:
com.jxfs.events.JxfsException

prepareEject

public int prepareEject(int mediaControl,
                        int controlID)
                 throws com.jxfs.events.JxfsException
/* prepareEject /

Specified by:
prepareEject in interface com.jxfs.service.IJxfsEjectService
Throws:
com.jxfs.events.JxfsException

printForm

public int printForm(java.lang.String formName,
                     java.lang.String mediaName,
                     java.lang.String[] fieldWriteData,
                     int controlID)
              throws com.jxfs.events.JxfsException
/* printForm /

Specified by:
printForm in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

printRawData

public int printRawData(byte[] rawData,
                        boolean inputData,
                        int controlID)
                 throws com.jxfs.events.JxfsException
/* printRawData /

Specified by:
printRawData in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

readForm

public int readForm(java.lang.String formName,
                    int controlID)
             throws com.jxfs.events.JxfsException
/* readForm /

Specified by:
readForm in interface com.jxfs.service.IJxfsReadService
Throws:
com.jxfs.events.JxfsException

readImage

public int readImage(int controlID)
              throws com.jxfs.events.JxfsException
/* readImage /

Specified by:
readImage in interface com.jxfs.service.IJxfsReadService
Throws:
com.jxfs.events.JxfsException

registerControl

public int registerControl(java.lang.String device_control_type,
                           com.jxfs.events.IJxfsEventNotification callbacks_implementing_control)
                    throws com.jxfs.events.JxfsException
Registers an IJxfsEventNotification implementing object at the service.

Specified by:
registerControl in interface com.jxfs.service.IJxfsBaseService
Parameters:
device_control_type - the name of the Device Control type.
Returns:
the controlId (control_id);
Throws:
com.jxfs.events.JxfsException - JXFS_E_REMOTE - in case of network error.

release

public boolean release(int timeout,
                       int control_id)
                throws com.jxfs.events.JxfsException
Removes exclusive access to the device. This is a synchronous call.

Specified by:
release in interface com.jxfs.service.IJxfsBaseService
Parameters:
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.
Returns:
boolean - true if successful, false otherwise.
Throws:
com.jxfs.events.JxfsException - JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_NOTCLAIMED.

releaseInternal

public void releaseInternal(int control_id)
/* /

Specified by:
releaseInternal in interface com.jxfs.forum.support.IQueueResponse

resetPrinter

public int resetPrinter(int controlID)
                 throws com.jxfs.events.JxfsException
/* resetPrinter /

Specified by:
resetPrinter in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

retractMedia

public int retractMedia(int mediaControl,
                        int controlID)
                 throws com.jxfs.events.JxfsException
/* retractMedia /

Specified by:
retractMedia in interface com.jxfs.service.IJxfsRetractService
Throws:
com.jxfs.events.JxfsException

setFormsConfig

public void setFormsConfig(com.jxfs.control.ptr.JxfsPtrFormsConfig formsConfig,
                           int controlID)
                    throws com.jxfs.events.JxfsException
/* setFormsConfig /

Specified by:
setFormsConfig in interface com.jxfs.service.IJxfsPrinterService
Throws:
com.jxfs.events.JxfsException

setRetractCount

public void setRetractCount(com.jxfs.control.ptr.JxfsPtrRetractCount rc,
                            int controlID)
                     throws com.jxfs.events.JxfsException
/* setRetractCount /

Specified by:
setRetractCount in interface com.jxfs.service.IJxfsRetractService
Throws:
com.jxfs.events.JxfsException

shutdown

public void shutdown()
              throws com.jxfs.events.JxfsException
This method is used by the Device Manager to deactivate a Device Service. The DS ends the current job (if not possible, it terminates the job) and throws away all the pending jobs (without sending OperationCompleteEvents). It then shuts down the physical device and writes any remaining persistent data into the repository. Finally, it sends a StatusEvent with the status JXFS_S_SHUTDOWN to all registered Device Controls. The Device Controls have to delete their reference to the Device Service and disable themselves (that is, they must return JXFS_E_UNREGISTERED out of any operation from now on). This event is then propagated to the application by the DC’s.

Specified by:
shutdown in interface com.jxfs.service.IJxfsBaseService
Throws:
com.jxfs.events.JxfsException - common exceptions.

turnMedia

public int turnMedia(int controlID)
              throws com.jxfs.events.JxfsException
/* turnMedia /

Specified by:
turnMedia in interface com.jxfs.service.IJxfsMediaTurnService
Throws:
com.jxfs.events.JxfsException

updateFirmware

public boolean updateFirmware(int control_id)
                       throws com.jxfs.events.JxfsException
Starts updating of the firmware.

Specified by:
updateFirmware in interface com.jxfs.service.IJxfsBaseService
Parameters:
control_id - an identifier for the calling Device Control.
Returns:
boolean - true, if the update process could be started.
Throws:
com.jxfs.events.JxfsException - JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_NOHARDWARE, JXFS_E_FIRMWARE, JXFS_E_NOT_SUPPORTED.

wakeUpFromPowerSave

public int wakeUpFromPowerSave(int control_id)
                        throws com.jxfs.events.JxfsException
Causes a device in power-save mode to return to a active state.

Specified by:
wakeUpFromPowerSave in interface com.jxfs.service.IJxfsBaseService
Parameters:
control_id - an identifier for the calling Device Control.
Returns:
int the number of seconds the device needs to get back to an active status or -1 if n/a.
Throws:
com.jxfs.events.JxfsException - JXFS_E_UNREGISTERED, JXFS_E_CLOSED, JXFS_E_REMOTE.

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005