| org.kuali.module.financial.service.CashDrawerService
All known Subclasses: org.kuali.module.financial.service.impl.CashDrawerServiceImpl,
| CashDrawerService | | public interface CashDrawerService (Code) | | This service interface defines methods that a CashDrawerService implementation must provide.
|
| Method Summary | |
| public void | closeCashDrawer(String workgroupName)
Closes the CashDrawer instance associated with the given workgroupName, creating one if necessary. | | public void | closeCashDrawer(CashDrawer cd)
| | public CashDrawer | getByWorkgroupName(String workgroupName, boolean autocreate)
Retrieves the CashDrawer instance associated with the given workgroupName, if any. | | public KualiDecimal | getCoinTotal(CashDrawer drawer)
Calculates the total amount of all the coins in the drawer. | | public KualiDecimal | getCurrencyTotal(CashDrawer drawer)
Calculates the total amount of all the currency in the drawer. | | public void | lockCashDrawer(String workgroupName, String documentId)
Locks the currently-open CashDrawer instance associated with the given workgroupName, throwing an IllegalStateException if
that cashDrawer is not open (i.e. | | public void | lockCashDrawer(CashDrawer cd, String documentId)
| | public CashDrawer | openCashDrawer(String workgroupName, String documentId)
Opens the CashDrawer instance associated with the given workgroupName, creating one if necessary. | | public CashDrawer | openCashDrawer(CashDrawer cd, String documentId)
| | public void | unlockCashDrawer(String workgroupName, String documentId)
Unlocks the currently-locked CashDrawer instance associated with the given workgroupName,
throwing an IllegalStateException if that cashDrawer is not locked (i.e. | | public void | unlockCashDrawer(CashDrawer cd, String documentId)
|
| closeCashDrawer | | public void closeCashDrawer(String workgroupName)(Code) | | Closes the CashDrawer instance associated with the given workgroupName, creating one if necessary.
Parameters:
workgroupName - The workgroup name used to retrieve the cash drawer to be closed. |
| closeCashDrawer | | public void closeCashDrawer(CashDrawer cd)(Code) | | Closes the cash drawer associated with the given document
Parameters:
cd - The cash drawer to closed. |
| getByWorkgroupName | | public CashDrawer getByWorkgroupName(String workgroupName, boolean autocreate)(Code) | | Retrieves the CashDrawer instance associated with the given workgroupName, if any. If autocreate is true,
and no CashDrawer for the given workgroupName exists, getByWorkgroupName will return a newly-created
(non-persisted) CashDrawer instance.
Parameters:
workgroupName - The workgroup name used to retrieve the cash drawer.
Parameters:
autocreate - Identifies whether or not a new cash drawer will be created if one does not already exist for the workgroup name provided. CashDrawer instance or null |
| getCoinTotal | | public KualiDecimal getCoinTotal(CashDrawer drawer)(Code) | | Calculates the total amount of all the coins in the drawer.
Parameters:
drawer - The drawer to calculate the coin total from. The summed value of coins in the drawer. |
| getCurrencyTotal | | public KualiDecimal getCurrencyTotal(CashDrawer drawer)(Code) | | Calculates the total amount of all the currency in the drawer.
NOTE: The value returned only refers to paper currency in the drawer and does not include coin amounts.
Parameters:
drawer - The cash drawer to calculate the currency total from. The summed amount of currency in the cash drawer. |
| lockCashDrawer | | public void lockCashDrawer(String workgroupName, String documentId)(Code) | | Locks the currently-open CashDrawer instance associated with the given workgroupName, throwing an IllegalStateException if
that cashDrawer is not open (i.e. is closed or locked). Records the given documentId as the document which locked the
cashDrawer.
Parameters:
workgroupName - The workgroup name used to retrieve the cash drawer to be locked.
Parameters:
documentId - The id of the document used to lock the cash drawer. |
| lockCashDrawer | | public void lockCashDrawer(CashDrawer cd, String documentId)(Code) | | Locks the given cash drawer, if it is open
Parameters:
cd - The cash drawer to open
Parameters:
documentId - The document id which is locking the cash drawer |
| openCashDrawer | | public CashDrawer openCashDrawer(String workgroupName, String documentId)(Code) | | Opens the CashDrawer instance associated with the given workgroupName, creating one if necessary. Records the given
documentId as the document which opened the cashdrawer.
Parameters:
workgroupName - The workgroup name to be used to retrieve the cash drawer to be closed.
Parameters:
documentId - The id of the document used to open the cash drawer. The opened version of the cash drawer. |
| openCashDrawer | | public CashDrawer openCashDrawer(CashDrawer cd, String documentId)(Code) | | Opens the given cash drawer
Parameters:
cd - The cash drawer to open
Parameters:
documentId - the document number which is opening the cash drawer The opened version of the cash drawer |
| unlockCashDrawer | | public void unlockCashDrawer(String workgroupName, String documentId)(Code) | | Unlocks the currently-locked CashDrawer instance associated with the given workgroupName,
throwing an IllegalStateException if that cashDrawer is not locked (i.e. is closed or open).
Records the given documentId as the document which unlocked the cashDrawer.
Parameters:
workgroupName - The workgroup name used to retrieve the cash drawer to be unlocked.
Parameters:
documentId - The id of the document used to unlock the cash drawer. |
| unlockCashDrawer | | public void unlockCashDrawer(CashDrawer cd, String documentId)(Code) | | Unlocks the given cash drawer, if it is open and locked
Parameters:
cd - The cash drawer to unlock
Parameters:
documentId - The document which is unlocking the cash drawer |
|
|