Interface ItemDispenserInterface
- All Superinterfaces:
JposBaseInterface
- All Known Implementing Classes:
ItemDispenserProperties
Interface for methods that implement property setter and method calls for the ItemDispenser device category.
For details about properties, methods and method parameters, see UPOS specification, chapter Item Dispenser.
Further details about error handling can be found in introduction - Device Behavior Models - Errors.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
adjustItemCount(int itemCount, int slotNumber)
Final part of AdjustItemCount method.void
dispenseItem(int[] numItem, int slotNumber)
Final part of DispenseItem method.void
readItemCount(int[] itemCount, int slotNumber)
Final part of ReadItemCount 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
-
adjustItemCount
void adjustItemCount(int itemCount, int slotNumber) throws jpos.JposExceptionFinal part of AdjustItemCount 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,
- itemCount is a positive value,
- slotNumber is between 1 and MaxSlots.
- Parameters:
itemCount
- Number of items currently in the specified slot.slotNumber
- Slot number.- Throws:
jpos.JposException
- If an error occurs.
-
dispenseItem
void dispenseItem(int[] numItem, int slotNumber) throws jpos.JposExceptionFinal part of DispenseItem 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,
- numItem is not null and has length 1,
- slotNumber is between 1 and MaxSlots.
- Parameters:
numItem
- Number of items to be dispensed from given slot.slotNumber
- Slot number to be used to dispense item(s).- Throws:
jpos.JposException
- If an error occurs.
-
readItemCount
void readItemCount(int[] itemCount, int slotNumber) throws jpos.JposExceptionFinal part of ReadItemCount 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,
- itemCount is not null and has length 1,
- itemCount[0] > 0,
- slotNumber is between 1 and MaxSlots.
- Parameters:
itemCount
- Target for item count of the specified slot.slotNumber
- Slot number to be used to read slot specific item count.- Throws:
jpos.JposException
- If an error occurs.
-