com.cloudpos.cashdrawer

Interface CashDrawerDevice

All Superinterfaces:

Device

public interface CashDrawerDevice
extends Device

The CashDrawerDevice interface defines the APIs for controlling cash drawer devices in applications. Implementations providing cash drawer services must supply a concrete class implementing this interface.

To obtain a cash drawer device object from the POSTerminal, use the following code:

 CashDrawerDevice cashDrawerDevice =
         (CashDrawerDevice) POSTerminal.getInstance().getDevice("com.cloudpos.device.cashdrawer");
 

The identifier "com.cloudpos.device.cashdrawer" is used to specify the cash drawer device, as defined by the specific implementation.

Applications can control the cash drawer device using this interface and must request the necessary permissions:

<uses-permission android:name="android.permission.CLOUDPOS_MONEYBOX"/>

See Also:

Device

Method Summary

Modifier and Type	Method and Description
void	kickOut() Triggers the cash drawer to open (kick out).
void	open(int logicalID) Opens the cash drawer for use.
void	openCashBox() Open Cash Box.
int	queryStatus() Queries the status of the cash drawer.

Methods inherited from interface com.cloudpos.Device

cancelRequest, close, getFailCount, getUsageCount, open

Method Detail

kickOut

void kickOut()
      throws DeviceException

Triggers the cash drawer to open (kick out).

Throws:

DeviceException - for standard errors as documented in DeviceException.

open

void open(int logicalID)
   throws DeviceException

Opens the cash drawer for use.

Parameters:

logicalID - Logical ID of the cash drawer to open.

Throws:

DeviceException - for standard errors as documented in DeviceException.

openCashBox

void openCashBox()
          throws DeviceException

Open Cash Box.

Throws:

DeviceException - for standard errors as documented in DeviceException.

queryStatus

int queryStatus()
         throws DeviceException

Queries the status of the cash drawer.

Returns:

The status of the cash drawer: 0 for opened, 1 for closed, -1 for unknown.

Throws:

DeviceException - for standard errors as documented in DeviceException.