com.acs.smartcard
Class ReadKeyOption

java.lang.Object
  extended by com.acs.smartcard.ReadKeyOption

public class ReadKeyOption
extends java.lang.Object

This class represents READ_KEY_OPTION structure in ACR83/APG8201 reader.

Since:
1.1

Constructor Summary
ReadKeyOption()
          Creates an instance of ReadKeyOption.
ReadKeyOption(int timeOut, int pinMaxExtraDigit, int keyReturnCondition, int echoLcdStartPosition, int echoLcdMode)
          Creates and initializes an instance of ReadKeyOption.
 
Method Summary
 int getEchoLcdMode()
          Gets the LCD echo mode.
 int getEchoLcdStartPosition()
          Gets the LCD starting position.
 int getKeyReturnCondition()
          Gets the key return condition.
 int getPinMaxExtraDigit()
          Gets the PIN max extra digit.
 int getTimeOut()
          Gets the timeout.
 void setEchoLcdMode(int echoLcdMode)
          Sets the LCD echo mode.
 void setEchoLcdStartPosition(int echoLcdStartPosition)
          Sets the LCD starting position.
 void setKeyReturnCondition(int keyReturnCondition)
          Sets the key return condition.
 void setPinMaxExtraDigit(int pinMaxExtraDigit)
          Sets the PIN max extra digit.
 void setTimeOut(int timeOut)
          Sets the timeout.
 byte[] toByteArray()
          Converts the ReadKeyOption to the byte array.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReadKeyOption

public ReadKeyOption()
Creates an instance of ReadKeyOption.


ReadKeyOption

public ReadKeyOption(int timeOut,
                     int pinMaxExtraDigit,
                     int keyReturnCondition,
                     int echoLcdStartPosition,
                     int echoLcdMode)
Creates and initializes an instance of ReadKeyOption.

Parameters:
timeOut - the timeout value in seconds. If 00h then default value is used.
pinMaxExtraDigit - the PIN max extra digit (XXYYh). XX: Minimum PIN size in digit YY: Maximum PIN size in digit
keyReturnCondition - the key return condition. The value is a bit wise OR operation. 01h: Max size reached. 02h: Key [E] pressed. 04h: Timeout occurred. 08h: Key [C] pressed. 10h: Key [<-] pressed. 20h: Key [FN] pressed. 40h: Smart Card out detected. (if enable, no key will be returned.)
echoLcdStartPosition - the LCD starting position. The value is from 0 from 31.
echoLcdMode - the LCD echo mode. 00h: Echo key press data ASCII representation to LCD. 01h: Display all key presses as asterisks “*” on LCD. 02h: No echo.
Method Detail

getTimeOut

public int getTimeOut()
Gets the timeout.

Returns:
the timeout.

setTimeOut

public void setTimeOut(int timeOut)
Sets the timeout.

Parameters:
timeOut - the timeout.

getPinMaxExtraDigit

public int getPinMaxExtraDigit()
Gets the PIN max extra digit.

Returns:
the PIN max extra digit.

setPinMaxExtraDigit

public void setPinMaxExtraDigit(int pinMaxExtraDigit)
Sets the PIN max extra digit.

Parameters:
pinMaxExtraDigit - the PIN max extra digit.

getKeyReturnCondition

public int getKeyReturnCondition()
Gets the key return condition.

Returns:
the key return condition.

setKeyReturnCondition

public void setKeyReturnCondition(int keyReturnCondition)
Sets the key return condition.

Parameters:
keyReturnCondition - the key return condition.

getEchoLcdStartPosition

public int getEchoLcdStartPosition()
Gets the LCD starting position.

Returns:
the LCD starting position.

setEchoLcdStartPosition

public void setEchoLcdStartPosition(int echoLcdStartPosition)
Sets the LCD starting position.

Parameters:
echoLcdStartPosition - the LCD starting position.

getEchoLcdMode

public int getEchoLcdMode()
Gets the LCD echo mode.

Returns:
the LCD echo mode.

setEchoLcdMode

public void setEchoLcdMode(int echoLcdMode)
Sets the LCD echo mode.

Parameters:
echoLcdMode - the LCD echo mode.

toByteArray

public byte[] toByteArray()
Converts the ReadKeyOption to the byte array.

Returns:
the byte array.


Copyright © 2011-2012 Advanced Card Systems Ltd. All Rights Reserved.