Package de.gmxhome.conrad.jpos.jpos_base.rfidscanner

Interface RFIDScannerInterface

All Superinterfaces:

JposBaseInterface

All Known Implementing Classes:

RFIDScannerProperties

public interface RFIDScannerInterface
extends JposBaseInterface

Interface for methods that implement property setter and method calls for the RFIDScanner device category. For details about properties, methods and method parameters, see UPOS specification, chapter RFID Scanner. Further details about error handling can be found in introduction - Device Behavior Models - Errors.
No final parts have been specified for methods FirstTag, NextTag and PreviousTag because these methods will be handled completely by the service. A specific service implementation must only fill all tag data into an RFIDScannerDataEvent and fire that event, The remainder will be handled via standard event handling and via standard method implementations within the RFIDScannerService object.

Method Summary

Modifier and Type	Method	Description
DisableTag	disableTag(byte[] tagID, int timeout, byte[] password)	Validation part of DisableTag method.
void	disableTag(DisableTag request)	Final part of DisableTag method.
LockTag	lockTag(byte[] tagID, int timeout, byte[] password)	Validation part of LockTag method.
void	lockTag(LockTag request)	Final part of LockTag method.
void	protocolMask(int mask)	Final part of setting ProtocolMask.
ReadTags	readTags(int cmd, byte[] filterID, byte[] filtermask, int start, int length, int timeout, byte[] password)	Validation part of ReadTags method.
void	readTags(ReadTags request)	Final part of ReadTags method.
void	readTimerInterval(int interval)	Final part of setting ReadTimerInterval.
StartReadTags	startReadTags(int cmd, byte[] filterID, byte[] filtermask, int start, int length, byte[] password)	Final part of StartReadTags method.
void	startReadTags(StartReadTags request)	Final part of StartReadTags method.
void	stopReadTags(byte[] password)	Final part of StopReadTags method.
WriteTagData	writeTagData(byte[] tagID, byte[] userdata, int start, int timeout, byte[] password)	Validation part of WriteTagData method.
void	writeTagData(WriteTagData request)	Final part of WriteTagData method.
WriteTagID	writeTagID(byte[] sourceID, byte[] destID, int timeout, byte[] password)	Validation part of DisableTag method.
void	writeTagID(WriteTagID request)	Final part of WriteTagID method.

Methods inherited from interface de.gmxhome.conrad.jpos.jpos_base.JposBaseInterface

asyncMode, autoDisable, checkHealth, claim, clearInput, clearOutput, close, compareFirmwareVersion, dataEventEnabled, deviceEnabled, directIO, directIO, flagWhenIdle, freezeEvents, handlePowerStateOnEnable, newJposOutputRequest, open, powerNotify, release, removeFromPropertySetList, resetStatistics, retrieveStatistics, retryInput, retryOutput, unitDataCount, updateFirmware, updateFirmware, updateStatistics

Method Details

protocolMask

void protocolMask(int mask)
           throws jpos.JposException

Final part of setting ProtocolMask. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is claimed,
• Mask contains only bits that are set in CapMultipleProtocols as well.

Parameters:

mask - Bit pattern wherein each bit signifies one predefined RFID tag protocol.

Throws:

jpos.JposException - If an error occurs.

readTimerInterval

void readTimerInterval(int interval)
                throws jpos.JposException

Final part of setting ReadTimerInterval. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is claimed,
• CapReadTimer is true,
• ContinuousReadMode is false,
• interval is not negative.

Parameters:

interval - The minimum time interval between tag reads in milliseconds.

Throws:

jpos.JposException - If an error occurs.

stopReadTags

void stopReadTags(byte[] password)
           throws jpos.JposException

Final part of StopReadTags method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• ContinuousReadMode is true.

After successful completion, ContinuousReadMode must be reset to false.

Parameters:

password - Authorized key for reader, if needed, null or zero length binary otherwise.

Throws:

jpos.JposException - If an error occurs.

startReadTags

StartReadTags startReadTags(int cmd,
 byte[] filterID,
 byte[] filtermask,
 int start,
 int length,
 byte[] password)
                     throws jpos.JposException

Final part of StartReadTags method. Can be overwritten in derived class, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapContinuousRead is true,
• ContinuousReadMode is false,
• State is S_IDLE,
• filterID and filtermask have the same length,
• cmd is one of RT_ID, RT_FULLUSERDATA, RT_PARTIALUSERDATA, RT_ID_FULLUSERDATA or RT_ID_PARTIALUSERDATA,
• If cmd is one of RT_PARTIALUSERDATA or RT_ID_PARTIALUSERDATA, start and length are positive.

Since the UPOS specification specifies StartReadMode as asynchronous method, this method must only start polling and return after setting ContinuousReadMode to true.

Parameters:

cmd - Read command, specifies what has to be read.

filterID - Holds a bit pattern to be AND’ed with filtermask to specify which tags shall be read.

filtermask - Mask for filterID and tag ID, a tag will be read whenever the tag ID AND'ed with filtermask is equal to filterID AND'ed with filtermask.

start - In case of partial user data read, start specifies the zero-based position within user data where read shall start.

length - In case of partial user data read, length specifies the number of bytes to be read.

password - Authorized key for reader, if needed, null or zero length binary otherwise.

Returns:

StartReadTags object for use in final part.

Throws:

jpos.JposException - If an error occurs.

readTags

ReadTags readTags(int cmd,
 byte[] filterID,
 byte[] filtermask,
 int start,
 int length,
 int timeout,
 byte[] password)
           throws jpos.JposException

Validation part of ReadTags method. Can be overwritten in derived class, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• ContinuousReadMode is false,
• State is S_IDLE,
• filterID and filtermask have the same length,
• cmd is one of RT_ID, RT_FULLUSERDATA, RT_PARTIALUSERDATA, RT_ID_FULLUSERDATA or RT_ID_PARTIALUSERDATA,
• If cmd is one of RT_PARTIALUSERDATA or RT_ID_PARTIALUSERDATA, start and length are positive,
• timeout is positive or FOREVER.

Since the UPOS specification specifies StartReadMode as asynchronous method, this method must only start polling and return after setting ContinuousReadMode to true.

Parameters:

cmd - Read command, specifies what has to be read.

filterID - Holds a bit pattern to be AND’ed with filtermask to specify which tags shall be read.

filtermask - Mask for filterID and tag ID, a tag will be read whenever the tag ID AND'ed with filtermask is equal to filterID AND'ed with filtermask.

start - In case of partial user data read, start specifies the zero-based position within user data where read shall start.

length - In case of partial user data read, length specifies the number of bytes to be read.

timeout - Allowed execution time, in milliseconds or FOREVER for unlimited execution time.

password - Authorized key for reader, if needed, null or zero length binary otherwise.

Returns:

ReadTags object for use in final part.

Throws:

jpos.JposException - If an error occurs.

disableTag

DisableTag disableTag(byte[] tagID,
 int timeout,
 byte[] password)
               throws jpos.JposException

Validation part of DisableTag method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapDisableTag is true,
• ContinuousReadMode is false,
• State is S_IDLE,
• timeout is positive or FOREVER.

Parameters:

tagID - Tag ID to be processed.

timeout - Allowed execution time, in milliseconds.

password - Authorized key for reader that might be required, zero length if not needed.

Returns:

DisableTag object for use in final part.

Throws:

jpos.JposException - If an error occurs.

lockTag

LockTag lockTag(byte[] tagID,
 int timeout,
 byte[] password)
         throws jpos.JposException

Validation part of LockTag method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapLockTag is true,
• ContinuousReadMode is false,
• State is S_IDLE,
• timeout is positive or FOREVER.

Parameters:

tagID - Tag ID to be processed.

timeout - Allowed execution time, in milliseconds.

password - Authorized key for reader that might be required, zero length if not needed.

Returns:

LockTag object for use in final part.

Throws:

jpos.JposException - If an error occurs.

writeTagData

WriteTagData writeTagData(byte[] tagID,
 byte[] userdata,
 int start,
 int timeout,
 byte[] password)
                   throws jpos.JposException

Validation part of WriteTagData method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapWriteTag is one of CWT_ALL or CWT_USERDATA,
• ContinuousReadMode is false,
• State is S_IDLE,
• start is positive,
• timeout is positive or FOREVER.

Parameters:

tagID - Tag ID to be processed.

userdata - Data to be written.

start - Zero-based position within the tags UserData field to begin writing.

timeout - Allowed execution time, in milliseconds.

password - Authorized key for reader that might be required, zero length if not needed.

Returns:

WriteTagData object for use in final part.

Throws:

jpos.JposException - If an error occurs.

writeTagID

WriteTagID writeTagID(byte[] sourceID,
 byte[] destID,
 int timeout,
 byte[] password)
               throws jpos.JposException

Validation part of DisableTag method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapWriteTag is one of CWT_ALL or CWT_ID,
• ContinuousReadMode is false,
• State is S_IDLE,
• timeout is positive or FOREVER.

Parameters:

sourceID - Original Tag ID to be processed.

destID - New ID of the tag.

timeout - Allowed execution time, in milliseconds.

password - Authorized key for reader that might be required, zero length if not needed.

Returns:

WriteTagID object for use in final part.

Throws:

jpos.JposException - If an error occurs.

disableTag

void disableTag(DisableTag request)
         throws jpos.JposException

Final part of DisableTag method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a DisableTag object. This method will be called when the corresponding operation shall be performed. All plausibility checks have been made before, only runtime errors can occur.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by DisableTag.

Throws:

jpos.JposException - If an error occurs.

lockTag

void lockTag(LockTag request)
      throws jpos.JposException

Final part of LockTag method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a LockTag object. This method will be called when the corresponding operation shall be performed. All plausibility checks have been made before, only runtime errors can occur.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by LockTag.

Throws:

jpos.JposException - If an error occurs.

writeTagData

void writeTagData(WriteTagData request)
           throws jpos.JposException

Final part of WriteTagData method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a WriteTagData object. This method will be called when the corresponding operation shall be performed. All plausibility checks have been made before, only runtime errors can occur.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by WriteTagData.

Throws:

jpos.JposException - If an error occurs.

writeTagID

void writeTagID(WriteTagID request)
         throws jpos.JposException

Final part of WriteTagID method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a WriteTagID object. This method will be called when the corresponding operation shall be performed. All plausibility checks have been made before, only runtime errors can occur.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by WriteTagID.

Throws:

jpos.JposException - If an error occurs.

readTags

void readTags(ReadTags request)
       throws jpos.JposException

Final part of ReadTags method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a ReadTags object. This method will be called when the corresponding operation shall be performed. All plausibility checks have been made before, only runtime errors can occur.

Parameters:

request - Input request object returned by validation method that contains all parameters to be used by ReadTags.

Throws:

jpos.JposException - If an error occurs.

startReadTags

void startReadTags(StartReadTags request)
            throws jpos.JposException

Final part of StartReadTags method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a StartReadTags object. This method will be called when the corresponding operation shall be performed. All plausibility checks have been made before, only runtime errors can occur.

Parameters:

request - Input request object returned by validation method that contains all parameters to be used by StartReadTags.

Throws:

jpos.JposException - If an error occurs.