|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.dse.base.DSENotifier | +--com.ibm.dse.base.Service | +--com.ibm.dse.services.checkreader.CheckReader
This is a service base class providing access to a magnetic/optical check reader using the Amper Standard protocol. The working mode can be synchronous or asynchronous.
Field Summary | |
static java.lang.String |
baudRateAttrib
The baudRate service attribute. |
static java.lang.String |
checkLinkAttrib
The checkLink service attribute. |
static java.lang.String |
COMPID
The component identification for tracing. |
static java.lang.String |
dataBitsAttrib
The dataBits service attribute. |
static java.lang.String |
even
The parity even value. |
static java.lang.String |
none
The parity none value. |
static java.lang.String |
odd
The parity odd value. |
static java.lang.String |
parityAttrib
The parity service attribute. |
static java.lang.String |
portAttrib
The port service attribute. |
static java.lang.String |
resetAttrib
The reset service attribute. |
static java.lang.String |
stopBitsAttrib
The stopBits service attribute. |
static java.lang.String |
timeoutAttrib
The timeout service attribute. |
static java.lang.String |
traceAttrib
The trace service attribute. |
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.ibm.dse.services.checkreader.CheckReaderInterface |
BAD_CHARACTER_EVENT,
CANCEL_EVENT,
COMPLETED_EVENT,
MALFUNCTION_EVENT,
TIMEOUT_EVENT,
UNKNOWN_EVENT |
Constructor Summary | |
CheckReader()
This constructor creates a CheckReader object. |
|
CheckReader(java.lang.String aName)
This constructor creates a CheckReader object. |
Method Summary | |
void |
cancel()
Cancels the read function. |
void |
close()
Closes the serial communications port. |
java.lang.String |
getDataRead()
Gets the data read from the device. |
java.lang.Object |
initializeFrom(Tag aTag)
Initializes a CheckReader object with the aTag attributes. |
void |
open()
Opens and initializes the serial communications port. |
void |
read()
Reads the data from the device in asynchronous mode. |
void |
readAndUnformat(Context aContext,
FormatElement aFormat)
Reads the data from the device in asynchronous mode and unformats it. |
java.lang.String |
readAndWait()
Reads the data from the device in synchronous mode. |
void |
readAndWaitAndUnformat(Context aContext,
FormatElement aFormat)
Reads the data from the device in synchronous mode and unformats it. |
void |
readCompleted(int retCode,
java.lang.String retMsg)
Processes the return code and the data when read is complete. |
java.lang.String |
toString()
Returns a visual representation of this object. |
Methods inherited from class com.ibm.dse.base.Service |
externalizer,
getExternalizer,
getTagName,
readExternal,
readExternal,
readObject,
removeExternal,
setExternalizer,
terminate,
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,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
public static final java.lang.String portAttrib
public static final java.lang.String baudRateAttrib
public static final java.lang.String dataBitsAttrib
public static final java.lang.String stopBitsAttrib
public static final java.lang.String parityAttrib
public static final java.lang.String timeoutAttrib
public static final java.lang.String checkLinkAttrib
public static final java.lang.String traceAttrib
public static final java.lang.String resetAttrib
public static final java.lang.String none
public static final java.lang.String odd
public static final java.lang.String even
public static final java.lang.String COMPID
Constructor Detail |
public CheckReader()
public CheckReader(java.lang.String aName) throws java.io.IOException
aName
- java.lang.StringMethod Detail |
public void cancel() throws DSECheckReaderException
public void close() throws DSECheckReaderException
public java.lang.String getDataRead()
public java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException, DSEException
aTag
- com.ibm.dse.base.Tag Contains the name and attributes of the object to be created.public void open() throws DSECheckReaderException
public void read() throws DSECheckReaderException
public void readAndUnformat(Context aContext, FormatElement aFormat) throws DSECheckReaderException
public java.lang.String readAndWait() throws DSECheckReaderException
public void readAndWaitAndUnformat(Context aContext, FormatElement aFormat) throws DSEInvalidArgumentException, DSEInvalidRequestException, DSECheckReaderException
public void readCompleted(int retCode, java.lang.String retMsg)
retCode
- int.retMsg
- String.public java.lang.String toString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |