at.hobex.pos.ecr.zvt

Class ConfigByte

java.lang.Object

at.hobex.pos.ecr.zvt.ConfigByte

public class ConfigByte
extends java.lang.Object

The Config-Byte is used to set different behavior of the payment terminal. The Config-Byte is send during the logon command to the terminal. The Config-Byte represents a bit field. To delete the configuration use ZVTClient.logoff().

Calculation of the config byte:

Config-Byte	Definition
0000 0001	reserved for further use
0000 0010	ECR assumes receipt-printout for payment functions (see also ECR Printing – ECR print-type) 0: payment receipt not printed by ECR 1: payment receipt printed by ECR
0000 0100	ECR assumes receipt-printout for administration functions (see also ECR print-type) 0: administration receipt not printed by ECR 1: administration receipt printed by ECR
0000 1000	ECR requires intermediate status-Information. The PT sends no intermediate statusinformation if not logged-on.
0001 0000	ECR controls payment function 0: Amount input on PT possible 1: Amount input on PT not possible
0010 0000	ECR controls administration function 0: Start of administration function on PT possible 1: Start of administration function on PT not possible
0100 0000	reserved for further use
1000 0000	ECR print-type (see also ECR assumes receipt-printout for payment functions and ECR assumes receipt-printout for administration functions): 0: Terminal will not send the receipt to the cash register. The receipt must be generated from the information in the ZVTResponse 1: Terminal sends receipt to cash register. To get the receipts use ZVTResponse.getMerchantReceipt() or ZVTResponse.getCustomerReceipt()

For example to request intermediate status-information set the Config-Byte to 8. If you want to request intermediate status information, control payment and control administration function you have to set the Config-Byte to int 56 or hex 0x38 (1000 (0x8) + 10000 (0x10) + 100000 (0x20)). Another way is to use the setter-Methods setEcrRequestsReceipt(boolean) and so on.

Since:

1.3

Author:

Nicolai Rechberger

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getConfigByte()
static boolean	isEcrControlsAdministrativeFunctions()
static boolean	isEcrControlsPaymentFunctions()
static boolean	isEcrPrintsAdministrativeReceipt()
static boolean	isEcrPrintsPaymentReceipt()
static boolean	isEcrRequestsReceipt()
static boolean	isEcrRequiredStatusInformation()
static void	setConfigByte(int configByte)
static void	setConfigByte(java.lang.String configByte)
static void	setEcrControlsAdministrativeFunctions(boolean ecrControlsAdministrativeFunctions)
static void	setEcrControlsPaymentFunctions(boolean ecrControlsPaymentFunctions)
static void	setEcrPrintsAdministrativeReceipt(boolean ecrPrintsAdministrativeReceipt)
static void	setEcrPrintsPaymentReceipt(boolean ecrPrintsPaymentReceipt)
static void	setEcrRequestsReceipt(boolean ecrRequestsReceipt)
static void	setEcrRequiredStatusInformation(boolean ecrRequiredStatusInformation)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getConfigByte

public static java.lang.String getConfigByte()

Returns:

The hex value representing the calculated Config-Byte setting.

isEcrControlsAdministrativeFunctions

public static boolean isEcrControlsAdministrativeFunctions()

Returns:

True if ecrControlsAdministrativeFunctions is set. If it is set the start of administrative functions on the terminal is not possible. On the terminal screen "ECR in use" appears.

isEcrControlsPaymentFunctions

public static boolean isEcrControlsPaymentFunctions()

Returns:

boolean True if ecrControlsPaymentFunctions is set. If it is set the start of payment functions on the terminal is not possible. On the terminal screen "ECR in use" appears.

isEcrPrintsAdministrativeReceipt

public static boolean isEcrPrintsAdministrativeReceipt()

Returns:

True if ecrPrintsAdministrativeReceipt is set, the receipt-printout for administrative functions must be done by the cash register. The terminal will not print a receipt for these kind of transaction.

isEcrPrintsPaymentReceipt

public static boolean isEcrPrintsPaymentReceipt()

Returns:

True if ecrPrintsPaymentReceipt is set, the receipt-printout for payment functions must be done by the cash register. The terminal will not print a receipt for these kind of transaction.

isEcrRequestsReceipt

public static boolean isEcrRequestsReceipt()

Returns:

If ecrRequestsReceipt is set, the terminal sends the receipts back to the ecr. To get the receipts use ZVTResponse.getMerchantReceipt() or ZVTResponse.getCustomerReceipt()

isEcrRequiredStatusInformation

public static boolean isEcrRequiredStatusInformation()

Returns:

If intermediate status information is set the terminal will return intermediate status information. You must also implement the IntermediateStatusInformationListener interface and add a intermediate status information listener. Status informations will distributed in the IntermediateStatusInformationListener.intermediateStatusInformation(IntermediateStatusInformation) method.

setConfigByte

public static void setConfigByte(int configByte)

Parameters:

configByte - To set the Config-Byte with the calculated hex value as int. eg. ConfigByte.setConfigByte(0xBE);

setConfigByte

public static void setConfigByte(java.lang.String configByte)

Parameters:

configByte - To set the Config-Byte with the calculated hex value as string. eg. ConfigByte.setConfigByte("BE");

setEcrControlsAdministrativeFunctions

public static void setEcrControlsAdministrativeFunctions(boolean ecrControlsAdministrativeFunctions)

Parameters:

ecrControlsAdministrativeFunctions - If ecrControlsAdministrativeFunctions is set the start of administrative functions on the terminal is not possible. On the terminal screen "ECR in use" appears.

setEcrControlsPaymentFunctions

public static void setEcrControlsPaymentFunctions(boolean ecrControlsPaymentFunctions)

Parameters:

ecrControlsPaymentFunctions - If ecrControlsPaymentFunctions is set the start of payment functions on the terminal is not possible. On the terminal screen "ECR in use" appears.

setEcrPrintsAdministrativeReceipt

public static void setEcrPrintsAdministrativeReceipt(boolean ecrPrintsAdministrativeReceipt)

Parameters:

ecrPrintsAdministrativeReceipt - If ecrPrintsAdministrativeReceipt is set, the receipt-printout for administrative functions must be done by the cash register. The terminal will not print a receipt for these kind of transaction.

setEcrPrintsPaymentReceipt

public static void setEcrPrintsPaymentReceipt(boolean ecrPrintsPaymentReceipt)

Parameters:

ecrPrintsPaymentReceipt - If ecrPrintsPaymentReceipt is set, the receipt-printout for payment functions must be done by the cash register. The terminal will not print a receipt for these kind of transaction.

setEcrRequestsReceipt

public static void setEcrRequestsReceipt(boolean ecrRequestsReceipt)

Parameters:

ecrRequestsReceipt - If ecrRequestsReceipt is set, the terminal sends the receipts back to the ecr. To get the receipts use ZVTResponse.getMerchantReceipt() or ZVTResponse.getCustomerReceipt()

setEcrRequiredStatusInformation

public static void setEcrRequiredStatusInformation(boolean ecrRequiredStatusInformation)

Parameters:

ecrRequiredStatusInformation - To get intermediate status information set ecrRequiredStatusInformation. Also implement the IntermediateStatusInformationListener interface and add a listener. Status informations will distributed in the IntermediateStatusInformationListener.intermediateStatusInformation(IntermediateStatusInformation) method. The PT sends no intermediate status information if not logged-on (registered).