com.siebel.rf.offline.data.currencybox
Class CurrencyBox

java.lang.Object
  |
  +--com.siebel.rf.offline.data.currencybox.CurrencyBox

All Implemented Interfaces:

Persisted

public class CurrencyBox

extends java.lang.Object

implements Persisted

The CurrencyBox persisted class

Field Summary

java.lang.String	branchCode
java.lang.String	cashBoxId
java.lang.String	companyCode
java.lang.String	currency
java.lang.String	currencyBoxId
static java.util.HashMap	MAPPING
java.lang.String	mode
static java.util.ArrayList	PK_ATTRBUTES
java.lang.Double	runningTotal
java.lang.Double	totalCoinValue
java.lang.Double	totalNoteValue

Constructor Summary

CurrencyBox()

Method Summary

com.bankframe.vo.retail.solutionset.impl.financialtransactions.FinancialTransactionCurrencyDifferenceVO	calculateVariances(java.lang.Double denominationValue, java.lang.String denominationIndicator, java.lang.String numberOfSingleDenomination) Calculates Variances
java.util.Vector	createActualTotalsSnapshot(java.util.Vector financialTransactionCashIn, java.lang.String snapShotType, java.lang.String date, java.lang.String journalEntryId) Creates ActualTotalsSnapshot
CurrencyBoxDenominationSnapshot	createCurrencyBoxDenominationSnapshot(CurrencyBoxDenomination currencyBoxDenomination, java.lang.String journalEntryId, java.lang.String snapShotType, java.lang.String date) Creates CurrencyBoxDenominationSnapshot
void	creditCash(java.lang.Double totalCashAmount) Credits cash to CurrencyBox
void	creditDenomination(java.util.Vector financialTransactionCashInVOs, java.lang.String transactionDate, java.lang.String transactionTime) Credits denominations to CurrencyBoxDenomination
void	debitCash(java.lang.Double totalCashAmount) Debits CurrencyBox
void	debitDenomination(java.util.Vector financialTransactionCashOutVOs, java.lang.String transactionDate, java.lang.String transactionTime) Debits denominations from CurrencyBoxDenomination
boolean	equals(java.lang.Object object) Compares object
java.lang.String	getBranchCode() Returns branchCode
java.lang.String	getCashBoxId() Returns cashBoxId
java.lang.String	getCompanyCode() Returns companyCode
java.lang.String	getCurrency() Returns currency
java.util.Collection	getCurrencyBoxDenominationDetails() Returns CurrencyBoxDenominationDetails
java.util.Vector	getCurrencyBoxDenominationSnapshotsBySnapshotTypeAndDate(java.lang.String snapshotType, java.lang.String date) Returns Vector of CurrencyBoxDenominationSnapshot
java.lang.String	getCurrencyBoxId() Returns currencyBoxId
java.util.HashMap	getMapping() Returns attributes vs.
java.lang.String	getMode() Returns mode
java.util.ArrayList	getPKAttributes() Returns collection of primary key attributes
java.lang.Double	getRunningTotal() Returns runningTotal
java.lang.String	getTableName() Returns table name of CurrencyBox
java.lang.Double	getTotalCoinValue() Returns totalCoinValue
java.lang.Double	getTotalNoteValue() Returns totalNoteValue
void	setBranchCode(java.lang.String branchCode) Sets branchCode
void	setCashBoxId(java.lang.String cashBoxId) Sets cashBoxId
void	setCompanyCode(java.lang.String companyCode) Sets companyCode
void	setCurrency(java.lang.String currency) Sets currency
void	setCurrencyBoxId(java.lang.String currencyBoxId) Sets currencyBoxId
void	setMode(java.lang.String mode) Sets mode
void	setRunningTotal(java.lang.Double runningTotal) Sets runningTotal
void	setTotalCoinValue(java.lang.Double totalCoinValue) Sets totalCoinValue
void	setTotalNoteValue(java.lang.Double totalNoteValue) Sets totalNoteValue
com.bankframe.bo.DataPacket	toDataPacket() Creates dataPacket for CurrencyBox
java.lang.String	toString() Converts DataPacket to String

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

companyCode

public java.lang.String companyCode

branchCode

public java.lang.String branchCode

currencyBoxId

public java.lang.String currencyBoxId

cashBoxId

public java.lang.String cashBoxId

currency

public java.lang.String currency

mode

public java.lang.String mode

runningTotal

public java.lang.Double runningTotal

totalNoteValue

public java.lang.Double totalNoteValue

totalCoinValue

public java.lang.Double totalCoinValue

MAPPING

public static java.util.HashMap MAPPING

PK_ATTRBUTES

public static java.util.ArrayList PK_ATTRBUTES

Constructor Detail

CurrencyBox

public CurrencyBox()

Method Detail

getCompanyCode

public java.lang.String getCompanyCode()

Returns companyCode

Returns:

the value of companyCode

getBranchCode

public java.lang.String getBranchCode()

Returns branchCode

Returns:

the value of branchCode

getCurrencyBoxId

public java.lang.String getCurrencyBoxId()

Returns currencyBoxId

Returns:

the value of currencyBoxId

getCashBoxId

public java.lang.String getCashBoxId()

Returns cashBoxId

Returns:

the value of cashBoxId

getCurrency

public java.lang.String getCurrency()

Returns currency

Returns:

the value of currency

getMode

public java.lang.String getMode()

Returns mode

Returns:

the value of mode

getRunningTotal

public java.lang.Double getRunningTotal()

Returns runningTotal

Returns:

the value of runningTotal

getTotalNoteValue

public java.lang.Double getTotalNoteValue()

Returns totalNoteValue

Returns:

the value of totalNoteValue

getTotalCoinValue

public java.lang.Double getTotalCoinValue()

Returns totalCoinValue

Returns:

the value of totalCoinValue

setCompanyCode

public void setCompanyCode(java.lang.String companyCode)

Sets companyCode

Parameters:

companyCode - String

setBranchCode

public void setBranchCode(java.lang.String branchCode)

Sets branchCode

Parameters:

branchCode - String

setCurrencyBoxId

public void setCurrencyBoxId(java.lang.String currencyBoxId)

Sets currencyBoxId

Parameters:

currencyBoxId - String

setCashBoxId

public void setCashBoxId(java.lang.String cashBoxId)

Sets cashBoxId

Parameters:

cashBoxId - String

setCurrency

public void setCurrency(java.lang.String currency)

Sets currency

Parameters:

currency - String

setMode

public void setMode(java.lang.String mode)

Sets mode

Parameters:

mode - String

setRunningTotal

public void setRunningTotal(java.lang.Double runningTotal)

Sets runningTotal

Parameters:

runningTotal - Double

setTotalNoteValue

public void setTotalNoteValue(java.lang.Double totalNoteValue)

Sets totalNoteValue

Parameters:

totalNoteValue - Double

setTotalCoinValue

public void setTotalCoinValue(java.lang.Double totalCoinValue)

Sets totalCoinValue

Parameters:

totalCoinValue - Double

getMapping

public java.util.HashMap getMapping()

Returns attributes vs. table column name mapping

Specified by:

getMapping in interface Persisted

Returns:

the attributes vs. table column name mapping

getPKAttributes

public java.util.ArrayList getPKAttributes()

Returns collection of primary key attributes

Specified by:

getPKAttributes in interface Persisted

Returns:

the collection of primary key attributes

getTableName

public java.lang.String getTableName()

Returns table name of CurrencyBox

Specified by:

getTableName in interface Persisted

Returns:

the table name

toDataPacket

public com.bankframe.bo.DataPacket toDataPacket()

Creates dataPacket for CurrencyBox

Specified by:

toDataPacket in interface Persisted

Returns:

dataPacket DataPacket

toString

public java.lang.String toString()

Converts DataPacket to String

Overrides:

toString in class java.lang.Object

Returns:

String after converting the DataPacket to String

equals

public boolean equals(java.lang.Object object)

Compares object

Overrides:

equals in class java.lang.Object

Parameters:

object - Object

Returns:

boolean after comparing the object

getCurrencyBoxDenominationDetails

public java.util.Collection getCurrencyBoxDenominationDetails()

Returns CurrencyBoxDenominationDetails

Returns:

CurrencyBoxDenominationDetails based on companyCode , companyCode and currencyBoxId

calculateVariances

public com.bankframe.vo.retail.solutionset.impl.financialtransactions.FinancialTransactionCurrencyDifferenceVO calculateVariances(java.lang.Double denominationValue,
                                                                                                                                  java.lang.String denominationIndicator,
                                                                                                                                  java.lang.String numberOfSingleDenomination)
                                                                                                                           throws com.bankframe.ejb.ProcessingErrorException

Calculates Variances

Parameters:

financialTransactionCashInVOs - Vector

transactionDate - String

transactionTime - String

Returns:

financialTransactionCurrencyDifferenceVO

Throws:

ProcessingErrorexception - This exception is thrown if processing fails

createActualTotalsSnapshot

public java.util.Vector createActualTotalsSnapshot(java.util.Vector financialTransactionCashIn,
                                                   java.lang.String snapShotType,
                                                   java.lang.String date,
                                                   java.lang.String journalEntryId)
                                            throws com.bankframe.ejb.ProcessingErrorException,
                                                   com.bankframe.validation.ValidationException

Creates ActualTotalsSnapshot

Parameters:

financialTransactionCashIn - Vector

snapShotType - String

date - String

journalEntryId - String

Returns:

Vector of ActualTotalsSnapshot

Throws:

com.bankframe.validation.ValidationException - This exception is thrown if validation fails

ProcessingErrorexception - This exception is thrown if processing fails

createCurrencyBoxDenominationSnapshot

public CurrencyBoxDenominationSnapshot createCurrencyBoxDenominationSnapshot(CurrencyBoxDenomination currencyBoxDenomination,
                                                                             java.lang.String journalEntryId,
                                                                             java.lang.String snapShotType,
                                                                             java.lang.String date)
                                                                      throws com.bankframe.ejb.ProcessingErrorException,
                                                                             com.bankframe.validation.ValidationException

Creates CurrencyBoxDenominationSnapshot

Parameters:

currencyBoxDenomination - CurrencyBoxDenomination

journalEntryId - String

snapShotType - String

date - String

Returns:

currencyBoxDenominationSnapshot

Throws:

ProcessingErrorexception - This exception is thrown if processing fails

com.bankframe.validation.ValidationException - This exception is thrown if validation fails

creditCash

public void creditCash(java.lang.Double totalCashAmount)
                throws com.bankframe.ejb.ProcessingErrorException,
                       com.bankframe.validation.ValidationException

Credits cash to CurrencyBox

Parameters:

totalCashAmount - Double

Throws:

com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails

com.bankframe.validation.ValidationException - This exception is thrown if validation fails

creditDenomination

public void creditDenomination(java.util.Vector financialTransactionCashInVOs,
                               java.lang.String transactionDate,
                               java.lang.String transactionTime)
                        throws com.bankframe.ejb.ProcessingErrorException,
                               com.bankframe.validation.ValidationException

Credits denominations to CurrencyBoxDenomination

Parameters:

financialTransactionCashInVOs - Vector

transactionDate - String

transactionTime - String

Throws:

ProcessingErrorexception - This exception is thrown if processing fails

com.bankframe.validation.ValidationException - This exception is thrown if validation fails

debitCash

public void debitCash(java.lang.Double totalCashAmount)
               throws com.bankframe.ejb.ProcessingErrorException,
                      com.bankframe.validation.ValidationException

Debits CurrencyBox

Parameters:

totalCashAmount - Double

Throws:

com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails

com.bankframe.validation.ValidationException - This exception is thrown if validation fails

debitDenomination

public void debitDenomination(java.util.Vector financialTransactionCashOutVOs,
                              java.lang.String transactionDate,
                              java.lang.String transactionTime)
                       throws com.bankframe.ejb.ProcessingErrorException,
                              com.bankframe.validation.ValidationException

Debits denominations from CurrencyBoxDenomination

Parameters:

financialTransactionCashOutVOs - Vector

transactionDate - String

transactionTime - String

Throws:

ProcessingErrorexception - This exception is thrown if processing fails

com.bankframe.validation.ValidationException - This exception is thrown if validation fails

getCurrencyBoxDenominationSnapshotsBySnapshotTypeAndDate

public java.util.Vector getCurrencyBoxDenominationSnapshotsBySnapshotTypeAndDate(java.lang.String snapshotType,
                                                                                 java.lang.String date)
                                                                          throws com.bankframe.ejb.ProcessingErrorException,
                                                                                 com.bankframe.validation.ValidationException

Returns Vector of CurrencyBoxDenominationSnapshot

Parameters:

snapshotType - String

date - String

Returns:

the CurrencyBoxDenominationSnapshot based on snapshot type and date.

Throws:

com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails

com.bankframe.validation.ValidationException - This exception is thrown if validation fails