IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.services.jxfs.chk
Class JXFSChk

java.lang.Object
  extended bycom.ibm.dse.base.DSENotifier
      extended bycom.ibm.dse.base.Service
          extended bycom.ibm.dse.services.jxfs.JXFSService
              extended bycom.ibm.dse.services.jxfs.chk.JXFSChk
All Implemented Interfaces:
java.util.EventListener, Externalizable, java.io.Externalizable, com.jxfs.control.chk.IJxfsCheckReaderConst, com.jxfs.general.IJxfsConst, com.jxfs.events.IJxfsIntermediateListener, com.jxfs.events.IJxfsOperationCompleteListener, com.jxfs.events.IJxfsStatusListener, Notifier, java.io.Serializable

public class JXFSChk
extends JXFSService
implements com.jxfs.control.chk.IJxfsCheckReaderConst

This class implements a Service that manages a JXFS Check Reader Device Control.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.dse.services.jxfs.JXFSService
AUTOOPEN_NO, AUTOOPEN_YES, configKey, ids, idSyncs, preOpenTimeout, sdmAddparm, sdmName, syncTimeout, trace, waitMsgTime, workstationName
 
Fields inherited from class com.ibm.dse.base.Service
externalizer
 
Fields inherited from class com.ibm.dse.base.DSENotifier
handlersList, name
 
Fields inherited from interface com.jxfs.control.chk.IJxfsCheckReaderConst
JXFS_CHK_IMAGE_BOTH, JXFS_CHK_IMAGE_FRONT, JXFS_CHK_IMAGE_NONE, JXFS_CHK_IMAGE_REAR, JXFS_CHK_INK_FULL, JXFS_CHK_INK_LOW, JXFS_CHK_INK_OUT, JXFS_CHK_LAMP_FADING, JXFS_CHK_LAMP_OK, JXFS_CHK_STAMP_BOTH, JXFS_CHK_STAMP_FRONT, JXFS_CHK_STAMP_NONE, JXFS_CHK_STAMP_REAR, JXFS_COPYRIGHT, JXFS_E_CHK_INVALIDMEDIA, JXFS_E_CHK_MEDIAJAMMED, JXFS_E_CHK_NOMEDIA, JXFS_E_CHK_NOTSUPPORTEDCAP, JXFS_E_CHK_PRINTERROR, JXFS_E_CHK_READFAILURE, JXFS_E_CHK_SWITCHFAILURE, JXFS_O_CHK_AUTOFEED, JXFS_O_CHK_PROCESS, JXFS_O_CHK_READDATE, JXFS_S_CHK_INK_STATUS, JXFS_S_CHK_LAMP_STATUS, JXFS_S_CHK_MEDIA_STATUS, JXFS_VERSION_CONTROL
 
Fields inherited from interface com.jxfs.general.IJxfsConst
JXFS_ALL, JXFS_ALM_OFFSET, JXFS_CAM_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_HARDWAREERROR, 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_ISO_OFFSET, JXFS_LEVEL_ACTIVE, JXFS_LEVEL_ALL, JXFS_LEVEL_CONFIGURED, JXFS_LEVEL_WORKSTATION, JXFS_LOG_USEROFFSET, 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_EQUAL, OK_NEWER, OK_OLDER, OK_OTHER
 
Fields inherited from interface com.jxfs.events.IJxfsOperationCompleteListener
JXFS_COPYRIGHT, JXFS_VERSION_CONTROL
 
Fields inherited from interface com.jxfs.events.IJxfsStatusListener
JXFS_COPYRIGHT, JXFS_VERSION_CONTROL
 
Fields inherited from interface com.jxfs.events.IJxfsIntermediateListener
JXFS_COPYRIGHT, JXFS_VERSION_CONTROL
 
Constructor Summary
JXFSChk()
          This constructor creates a JXFSChk object.
JXFSChk(java.lang.String aName)
          This constructor creates a JXFSChk object.
 
Method Summary
 com.jxfs.control.chk.JxfsCHKData getData()
          Returns the value of the data read from check reader.
 boolean getGetImage()
          Returns the value of the getImage property.
 java.lang.Object initializeFrom(Tag aTag)
          Initializes a JXFSChk object with the aTag attributes.
 void operationCompleteOccurred(com.jxfs.events.JxfsOperationCompleteEvent anEvent)
          Receives the operation complete events
 int processCheckSync()
          Makes a processCheck call to the jxfs device control and waits for the operation complete event.
 int processCheckSync(Context aContext, java.lang.String encodeDataKey, java.lang.String endorseDataKey)
          Makes a processCheck call to the jxfs device control and waits for the operation complete event.
 int processCheckSync(com.jxfs.control.chk.JxfsCHKProcessData jcpData)
          Makes a processCheck call to the JXFS device control and waits for the operation complete event
 int processCheckSync(com.jxfs.control.chk.JxfsCHKProcessData processData, Context aContext, java.lang.String encodeDataKey, java.lang.String endorseDataKey)
          Makes a processCheck call to the JXFS device control and waits for the operation complete event.
 int readDataAndUnformatSync(Context aContext, RecordFormat fcheck)
          Makes a readData call to the jxfs device control and waits for the operation complete event.
 int readDataSync()
          Makes a readData call to the jxfs device control and waits for the operation complete event.
 int setAutoFeedSync(boolean auto)
          Makes a setAutoFeed call to the JXFS device control and waits for the operation complete event.
 void setGetImage(boolean newValue)
          Sets the value of the getImage property.
 
Methods inherited from class com.ibm.dse.services.jxfs.JXFSService
cancel, claim, closeSync, finalize, getConfigKey, getDeviceControl, getDeviceManager, getDeviceName, getIniConfigFile, getSdmAddparm, getSdmName, getStatus, getWorkstationName, intermediateOccurred, isAutoOpen, isOpened, isValidURL, openSync, registerListener, release, setAutoOpen, setConfigKey, setDeviceName, setIniConfigFile, setPreOpenTimeout, setSdmAddparm, setSdmName, setSyncTimeout, setWorkstationName, statusOccurred, terminate, toString, waitForID, waitOpen
 
Methods inherited from class com.ibm.dse.base.Service
externalizer, getExternalizer, getTagName, readExternal, readExternal, readObject, removeExternal, setExternalizer, toStrings, toTags, writeExternal, writeExternal
 
Methods inherited from class com.ibm.dse.base.DSENotifier
addHandler, getHandlersList, getName, removeHandler, setName, signalEvent, signalEvent, signalEvent
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.dse.base.Externalizable
getName, setName
 

Constructor Detail

JXFSChk

public JXFSChk()
This constructor creates a JXFSChk object.


JXFSChk

public JXFSChk(java.lang.String aName)
        throws java.io.IOException
This constructor creates a JXFSChk object.

Parameters:
aName - java.lang.String
Throws:
java.io.IOException - The object cannot be created
Method Detail

getData

public com.jxfs.control.chk.JxfsCHKData getData()
Returns the value of the data read from check reader.

Returns:
JxfsCHKData - Data from check reader .

getGetImage

public boolean getGetImage()
Returns the value of the getImage property.

Returns:
boolean - The current value of getImage.

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException,
                                       DSEException
Initializes a JXFSChk object with the aTag attributes.

Specified by:
initializeFrom in interface Externalizable
Overrides:
initializeFrom in class JXFSService
Parameters:
aTag - com.ibm.dse.base.Tag Contains - the name and attributes of the object to be created.
Returns:
Object - An instance of JXFSChk.
Throws:
java.io.IOException - The object can not be created.
DSEException

operationCompleteOccurred

public void operationCompleteOccurred(com.jxfs.events.JxfsOperationCompleteEvent anEvent)
Receives the operation complete events

Specified by:
operationCompleteOccurred in interface com.jxfs.events.IJxfsOperationCompleteListener
Overrides:
operationCompleteOccurred in class JXFSService
Parameters:
anEvent - com.jxfs.events.JxfsOperationCompleteEvent - the JxfsOperationCompleteEvent event received

processCheckSync

public int processCheckSync()
                     throws com.jxfs.events.JxfsException,
                            DSEException
Makes a processCheck call to the jxfs device control and waits for the operation complete event. This method uses the processData object to specify the process to apply to the check.

Returns:
int - The JXFS result of the operation
Throws:
com.jxfs.events.JxfsException
DSEException

processCheckSync

public int processCheckSync(Context aContext,
                            java.lang.String encodeDataKey,
                            java.lang.String endorseDataKey)
                     throws com.jxfs.events.JxfsException,
                            DSEException
Makes a processCheck call to the jxfs device control and waits for the operation complete event. This methos uses the field values to specify the process to apply to the check. The EncodeData and endorseData is obtained from the context.

Parameters:
aContext - - the Context to get data values
encodeDataKey - - the composite key path to get encode data from the context
endorseDataKey - - the composite key path to get endorse data from the context
Returns:
int - The JXFS result of the operation
Throws:
com.jxfs.events.JxfsException
DSEException

processCheckSync

public int processCheckSync(com.jxfs.control.chk.JxfsCHKProcessData jcpData)
                     throws com.jxfs.events.JxfsException,
                            DSEException
Makes a processCheck call to the JXFS device control and waits for the operation complete event

Parameters:
jcpData - - The property class to specify the process to apply to the check
Returns:
int - The JXFS result of the operation
Throws:
com.jxfs.events.JxfsException
DSEException

processCheckSync

public int processCheckSync(com.jxfs.control.chk.JxfsCHKProcessData processData,
                            Context aContext,
                            java.lang.String encodeDataKey,
                            java.lang.String endorseDataKey)
                     throws com.jxfs.events.JxfsException,
                            DSEException
Makes a processCheck call to the JXFS device control and waits for the operation complete event. This method uses processData to specify the process to apply to the check. EncodeData and endorseData are obtained from the context.

Parameters:
processData - - The property class to specify the process to apply to the check
aContext - - The Context to get data values
encodeDataKey - - The composite key path to get encode data from the context
endorseDataKey - - The composite key path to get endorse data from the context
Returns:
int - The JXFS result of the operation
Throws:
com.jxfs.events.JxfsException
DSEException

readDataAndUnformatSync

public int readDataAndUnformatSync(Context aContext,
                                   RecordFormat fcheck)
                            throws com.jxfs.events.JxfsException,
                                   DSEException
Makes a readData call to the jxfs device control and waits for the operation complete event.

Parameters:
aContext - - The Context to unformat the data read
fcheck - - The RecordFormat to unformat the data read from the check
Returns:
int - The JXFS result of the operation
Throws:
com.jxfs.events.JxfsException
DSEException

readDataSync

public int readDataSync()
                 throws com.jxfs.events.JxfsException,
                        DSEException
Makes a readData call to the jxfs device control and waits for the operation complete event.

Returns:
int - The JXFS result of the operation
Throws:
com.jxfs.events.JxfsException
DSEException

setAutoFeedSync

public int setAutoFeedSync(boolean auto)
                    throws com.jxfs.events.JxfsException,
                           DSEException
Makes a setAutoFeed call to the JXFS device control and waits for the operation complete event.

Parameters:
auto - boolean - means autofeed is true or false
Returns:
int - The JXFS result of the operation
Throws:
com.jxfs.events.JxfsException
DSEException

setGetImage

public void setGetImage(boolean newValue)
Sets the value of the getImage property.

Parameters:
newValue - - The new value of the getImage property.

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005