org.kuali.kfs.fp.businessobject
Class CashieringTransaction

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.TransientBusinessObjectBase
          org.kuali.kfs.fp.businessobject.CashieringTransaction

All Implemented Interfaces:

Serializable, org.kuali.rice.kns.bo.BusinessObject

public class CashieringTransaction
extends org.kuali.rice.kns.bo.TransientBusinessObjectBase

This class represents a cashiering-related transaction used in the cash management document

See Also:

Serialized Form

Field Summary

static String

DETAIL_DOCUMENT_TYPE

Constructor Summary

CashieringTransaction(String campusCode, String referenceFinancialDocumentNumber)
Constructs a CashieringTransaction

Method Summary

void	addCheck(Check check) Adds a new check to the list.
Check	createNewCheck()
Check	getBaselineCheck(int index) Implementation creates empty Checks as a side-effect, so that Struts' efforts to set fields of lines which haven't been created will succeed rather than causing a NullPointerException.
List	getBaselineChecks()
String	getCampusCode() Gets the campusCode attribute.
Check	getCheck(int index) Retrieve a particular check at a given index in the list of checks.
int	getCheckCount() Gets the number of checks, since Sun doesn't have a direct getter for collection size
List	getChecks() Gets the checks attribute.
Check	getMoneyInCheck(int index) Retrieves a specific check from the list, by array index
List<Check>	getMoneyInChecks() Gets the moneyInChecks attribute.
CoinDetail	getMoneyInCoin() Gets the moneyInCoin attribute.
CurrencyDetail	getMoneyInCurrency() Gets the moneyInCurrency attribute.
org.kuali.rice.kns.util.KualiDecimal	getMoneyInTotal() This method calcuates how much money has come in to the "Money In" side of the transaction
CoinDetail	getMoneyOutCoin() Gets the moneyOutCoin attribute.
CurrencyDetail	getMoneyOutCurrency() Gets the moneyOutCurrency attribute.
org.kuali.rice.kns.util.KualiDecimal	getMoneyOutTotal() This method calculates how much money has gone out through the "Money Out" side of the transaction
Check	getNewCheck() Gets the newCheck attribute.
CashieringItemInProcess	getNewItemInProcess() Gets the newItemInProcess attribute.
Integer	getNextCheckSequenceId() Gets the nextCheckSequenceId attribute.
CashieringItemInProcess	getOpenItemInProcess(int index) This method returns a single open item in process
List<CashieringItemInProcess>	getOpenItemsInProcess() Gets the openItemsInProcess attribute.
org.kuali.rice.kns.util.KualiDecimal	getPaidBackItemsInProcessAmount() This method calculates how much money has been paid back in all items in process
String	getReferenceFinancialDocumentNumber() Gets the referenceFinancialDocumentNumber attribute.
org.kuali.rice.kns.util.KualiDecimal	getTotalCheckAmount()
Date	getTransactionEnded() Gets the transactionEnded attribute.
Date	getTransactionStarted() Gets the transactionStarted attribute.
boolean	hasBaselineCheck(int index)
void	prepareForSave() This method will make sure that all of the various currency, coin, check, and item in process detail records are populated with the correct info.
void	removeCheck(int index) This method removes a check from the list and updates the total appropriately.
void	setBaselineChecks(List baselineChecks) Sets the current List of baseline checks to the given List
void	setCampusCode(String campusCode) Sets the campusCode attribute value.
void	setChecks(List checks) Sets the checks attribute value.
void	setCheckTotal(org.kuali.rice.kns.util.KualiDecimal checkTotal) Deprecated.
void	setMoneyInChecks(List<Check> moneyInChecks) Sets the moneyInChecks attribute value.
void	setMoneyInCoin(CoinDetail moneyInCoin) Sets the moneyInCoin attribute value.
void	setMoneyInCurrency(CurrencyDetail moneyInCurrency) Sets the moneyInCurrency attribute value.
void	setMoneyOutCoin(CoinDetail moneyOutCoin) Sets the moneyOutCoin attribute value.
void	setMoneyOutCurrency(CurrencyDetail moneyOutCurrency) Sets the moneyOutCurrency attribute value.
void	setNewCheck(Check newCheck) Sets the newCheck attribute value.
void	setNewItemInProcess(CashieringItemInProcess newItemInProcess) Sets the newItemInProcess attribute value.
void	setNextCheckSequenceId(Integer nextCheckSequenceId) Sets the nextCheckSequenceId attribute value.
void	setOpenItemsInProcess(List<CashieringItemInProcess> openItemsInProcess) Sets the openItemsInProcess attribute value.
void	setReferenceFinancialDocumentNumber(String referenceFinancialDocumentNumber) Sets the referenceFinancialDocumentNumber attribute value.
void	setTransactionEnded(Date transactionEnded) Sets the transactionEnded attribute value.
void	setTransactionStarted(Date transactionStarted) Sets the transactionStarted attribute value.
protected LinkedHashMap	toStringMapper()

Methods inherited from class org.kuali.rice.kns.bo.TransientBusinessObjectBase

refresh

Methods inherited from class org.kuali.rice.kns.bo.BusinessObjectBase

prepareForWorkflow, toString, toStringBuilder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DETAIL_DOCUMENT_TYPE

public static final String DETAIL_DOCUMENT_TYPE

See Also:

Constant Field Values

Constructor Detail

CashieringTransaction

public CashieringTransaction(String campusCode,
                             String referenceFinancialDocumentNumber)

Constructs a CashieringTransaction

Method Detail

getMoneyInChecks

public List<Check> getMoneyInChecks()

Gets the moneyInChecks attribute.

Returns:

Returns the moneyInChecks.

setMoneyInChecks

public void setMoneyInChecks(List<Check> moneyInChecks)

Sets the moneyInChecks attribute value.

Parameters:

moneyInChecks - The moneyInChecks to set.

getMoneyInCheck

public Check getMoneyInCheck(int index)

Retrieves a specific check from the list, by array index

Parameters:

index - the index of the checks array to retrieve the check from

Returns:

a Check

getMoneyInCoin

public CoinDetail getMoneyInCoin()

Gets the moneyInCoin attribute.

Returns:

Returns the moneyInCoin.

setMoneyInCoin

public void setMoneyInCoin(CoinDetail moneyInCoin)

Sets the moneyInCoin attribute value.

Parameters:

moneyInCoin - The moneyInCoin to set.

getMoneyInCurrency

public CurrencyDetail getMoneyInCurrency()

Gets the moneyInCurrency attribute.

Returns:

Returns the moneyInCurrency.

setMoneyInCurrency

public void setMoneyInCurrency(CurrencyDetail moneyInCurrency)

Sets the moneyInCurrency attribute value.

Parameters:

moneyInCurrency - The moneyInCurrency to set.

getMoneyOutCoin

public CoinDetail getMoneyOutCoin()

Gets the moneyOutCoin attribute.

Returns:

Returns the moneyOutCoin.

setMoneyOutCoin

public void setMoneyOutCoin(CoinDetail moneyOutCoin)

Sets the moneyOutCoin attribute value.

Parameters:

moneyOutCoin - The moneyOutCoin to set.

getTransactionEnded

public Date getTransactionEnded()

Gets the transactionEnded attribute.

Returns:

Returns the transactionEnded.

setTransactionEnded

public void setTransactionEnded(Date transactionEnded)

Sets the transactionEnded attribute value.

Parameters:

transactionEnded - The transactionEnded to set.

getTransactionStarted

public Date getTransactionStarted()

Gets the transactionStarted attribute.

Returns:

Returns the transactionStarted.

setTransactionStarted

public void setTransactionStarted(Date transactionStarted)

Sets the transactionStarted attribute value.

Parameters:

transactionStarted - The transactionStarted to set.

getCampusCode

public String getCampusCode()

Gets the campusCode attribute.

Returns:

Returns the campusCode.

setCampusCode

public void setCampusCode(String campusCode)

Sets the campusCode attribute value.

Parameters:

campusCode - The campusCode to set.

setMoneyOutCurrency

public void setMoneyOutCurrency(CurrencyDetail moneyOutCurrency)

Sets the moneyOutCurrency attribute value.

Parameters:

moneyOutCurrency - The moneyOutCurrency to set.

getReferenceFinancialDocumentNumber

public String getReferenceFinancialDocumentNumber()

Gets the referenceFinancialDocumentNumber attribute.

Returns:

Returns the referenceFinancialDocumentNumber.

setReferenceFinancialDocumentNumber

public void setReferenceFinancialDocumentNumber(String referenceFinancialDocumentNumber)

Sets the referenceFinancialDocumentNumber attribute value.

Parameters:

referenceFinancialDocumentNumber - The referenceFinancialDocumentNumber to set.

getMoneyOutCurrency

public CurrencyDetail getMoneyOutCurrency()

Gets the moneyOutCurrency attribute.

Returns:

Returns the moneyOutCurrency.

getNewItemInProcess

public CashieringItemInProcess getNewItemInProcess()

Gets the newItemInProcess attribute.

Returns:

Returns the newItemInProcess.

setNewItemInProcess

public void setNewItemInProcess(CashieringItemInProcess newItemInProcess)

Sets the newItemInProcess attribute value.

Parameters:

newItemInProcess - The newItemInProcess to set.

getOpenItemsInProcess

public List<CashieringItemInProcess> getOpenItemsInProcess()

Gets the openItemsInProcess attribute.

Returns:

Returns the openItemsInProcess.

setOpenItemsInProcess

public void setOpenItemsInProcess(List<CashieringItemInProcess> openItemsInProcess)

Sets the openItemsInProcess attribute value.

Parameters:

openItemsInProcess - The openItemsInProcess to set.

getOpenItemInProcess

public CashieringItemInProcess getOpenItemInProcess(int index)

This method returns a single open item in process

Returns:

a cashiering item in process

getNewCheck

public Check getNewCheck()

Gets the newCheck attribute.

Returns:

Returns the newCheck.

setNewCheck

public void setNewCheck(Check newCheck)

Sets the newCheck attribute value.

Parameters:

newCheck - The newCheck to set.

prepareForSave

public void prepareForSave()

This method will make sure that all of the various currency, coin, check, and item in process detail records are populated with the correct info.

toStringMapper

protected LinkedHashMap toStringMapper()

Specified by:

toStringMapper in class org.kuali.rice.kns.bo.BusinessObjectBase

See Also:

BusinessObjectBase.toStringMapper()

getChecks

public List getChecks()

Gets the checks attribute.

Returns:

Returns the checks.

setChecks

public void setChecks(List checks)

Sets the checks attribute value.

Parameters:

checks - The checks to set.

getCheckCount

public int getCheckCount()

Gets the number of checks, since Sun doesn't have a direct getter for collection size

Returns:

the number of checks

addCheck

public void addCheck(Check check)

Adds a new check to the list.

Parameters:

check -

getCheck

public Check getCheck(int index)

Retrieve a particular check at a given index in the list of checks.

Parameters:

index -

Returns:

Check

removeCheck

public void removeCheck(int index)

This method removes a check from the list and updates the total appropriately.

Parameters:

index -

getTotalCheckAmount

public org.kuali.rice.kns.util.KualiDecimal getTotalCheckAmount()

getNextCheckSequenceId

public Integer getNextCheckSequenceId()

Gets the nextCheckSequenceId attribute.

Returns:

Returns the nextCheckSequenceId.

setNextCheckSequenceId

public void setNextCheckSequenceId(Integer nextCheckSequenceId)

Sets the nextCheckSequenceId attribute value.

Parameters:

nextCheckSequenceId - The nextCheckSequenceId to set.

createNewCheck

public Check createNewCheck()

getPaidBackItemsInProcessAmount

public org.kuali.rice.kns.util.KualiDecimal getPaidBackItemsInProcessAmount()

This method calculates how much money has been paid back in all items in process

Returns:

the calculated amount

getBaselineChecks

public List getBaselineChecks()

Returns:

current List of baseline checks for use in update detection

setBaselineChecks

public void setBaselineChecks(List baselineChecks)

Sets the current List of baseline checks to the given List

Parameters:

baselineChecks -

hasBaselineCheck

public boolean hasBaselineCheck(int index)

Parameters:

index -

Returns:

true if a baselineCheck with the given index exists

getBaselineCheck

public Check getBaselineCheck(int index)

Implementation creates empty Checks as a side-effect, so that Struts' efforts to set fields of lines which haven't been created will succeed rather than causing a NullPointerException.

Parameters:

index -

Returns:

baseline Check at the given index

getMoneyInTotal

public org.kuali.rice.kns.util.KualiDecimal getMoneyInTotal()

This method calcuates how much money has come in to the "Money In" side of the transaction

Returns:

the amount calculated

getMoneyOutTotal

public org.kuali.rice.kns.util.KualiDecimal getMoneyOutTotal()

This method calculates how much money has gone out through the "Money Out" side of the transaction

Returns:

the amount calculated

setCheckTotal

public void setCheckTotal(org.kuali.rice.kns.util.KualiDecimal checkTotal)

Deprecated.

Parameters:

checkTotal -