com.siebel.rf.offline.data.branch
Class Branch

java.lang.Object
  |
  +--com.siebel.rf.offline.data.branch.Branch
All Implemented Interfaces:
Persisted

public class Branch
extends java.lang.Object
implements Persisted

The Branch persisted class


Field Summary
 java.lang.String branchCode
           
 java.lang.String branchControlNumber
           
 java.lang.String branchName
           
 java.lang.String branchOpen
           
 java.lang.String branchStatus
           
 java.lang.Double commissionAmount
           
 java.lang.String companyCode
           
 java.lang.String currentProcessingMode
           
static java.util.HashMap MAPPING
           
 java.lang.String nextCashBoxId
           
 java.lang.String nextEventId
           
 java.lang.String notificationTargetBranchCode
           
static java.util.ArrayList PK_ATTRBUTES
           
 java.lang.String processingDate
           
 java.lang.String processingDateRolloverTime
           
 java.lang.String processingMode
           
 java.lang.Double timeZoneDifference
           
 
Constructor Summary
Branch()
           
 
Method Summary
 java.lang.Boolean areAllTellerEndOfBusinessDaysComplete()
          Checks to see that all Tellers have completed their Teller End of Business Day transaction.
 boolean checkBranchClosed()
          Checks if the Branch is closed
 java.lang.Boolean checkCurrentProcessingMode()
          Checks that for a Branch working in AM/PM mode that the current processing mode for the Branch is AM when they are undertaking their Branch End of Business Day operation
 java.lang.Boolean checkModeAndDate()
          Checks to see that the processing mode on the Branch is AM/PM and that the processing date on the Branch is equal to the system date.
 void createBranchCurrencyTotalsSnapshotAtEndOfBusinessDay(java.lang.String snapshotType, java.util.Vector runningTotals, java.util.Vector notesTotals, java.util.Vector coinTotals, java.util.Vector currencys)
          Creates a snapshot of the Branch Currency Totals at the End of the Business Day.
 void createBranchCurrencyTotalsSnapshotAtEndOfDay(java.lang.String snapshotType)
          Creates snapshot of the Branch Currency Totals at the End of Day.
 boolean equals(java.lang.Object object)
          Compares object
 java.util.Vector getAllCashboxesForBranchByTypeAndCashBoxOpen(java.lang.String cashBoxType, java.lang.String cashBoxOpen)
          Returns Vector of CashBoxes return CashBoxes based on Type and CashBoxOpen
 java.util.Vector getAllCurrencyBoxDenominationSnapshotsForBranchBySnapshotTypeAndDate(java.lang.String snapshotType, java.lang.String date)
          Returns all currency box denomination snapshots
 java.lang.String getBranchCode()
          Returns branchCode
 java.lang.String getBranchControlNumber()
          Returns branchControlNumber
 java.util.Iterator getBranchCurrencyTotals()
          Returns currency totals
 java.lang.String getBranchName()
          Returns branchName
 java.lang.String getBranchOpen()
          Returns branchOpen
 java.lang.String getBranchStatus()
          Returns branchStatus
 java.util.Vector getCashBoxesAndNegotiableInstrumentBoxesDetailsForBranchByStatusAndType(java.lang.String cashBoxStatusIndicator, java.lang.String cashBoxType)
          Returns Vector of CashBoxes and associated NegotiableInstrumentBoxes and NegotiableInstruments
 java.util.Vector getCashBoxesForBranchByStatusAndType(java.lang.String cashBoxStatusIndicator, java.lang.String cashBoxType)
          Returns Vector of CashBoxes and associated currency boxes
 java.util.Vector getCashboxesForBranchByStatusAndTypeAndCashBoxMode(java.lang.String cashBoxStatusIndicator, java.lang.String cashBoxType, java.lang.String cashBoxMode)
          Returns Vector of CashBoxes
 java.lang.Double getCommissionAmount()
          Returns commissionAmount
 java.lang.String getCompanyCode()
          Returns companyCode
 java.lang.String getCurrentProcessingMode()
          Returns currentProcessingMode
 java.util.HashMap getMapping()
          Returns attributes vs.
 java.lang.String getNextCashBoxId()
          Returns nextCashBoxId
 java.lang.String getNextEventId()
          Returns nextEventId
 java.lang.String getNotificationTargetBranchCode()
          Returns notificationTargetBranchCode
 java.util.ArrayList getPKAttributes()
          Returns collection of primary key attributes
 java.lang.String getProcessingDate()
          Returns processingDate
 java.lang.String getProcessingDateRolloverTime()
          Returns processingDateRolloverTime
 java.lang.String getProcessingMode()
          Returns processingMode
 java.lang.String getTableName()
          Returns tableName of Branch
 java.lang.Double getTimeZoneDifference()
          Returns timeZoneDifference
 void setBranchClosed()
          Closes Branch
 void setBranchCode(java.lang.String branchCode)
          Sets branchCode
 void setBranchControlNumber(java.lang.String branchControlNumber)
          Sets branchControlNumber
 void setBranchName(java.lang.String branchName)
          Sets branchName
 void setBranchOpen(java.lang.String branchOpen)
          Sets the value of branchOpen
 void setBranchStatus(java.lang.String branchStatus)
          Sets branchStatus
 void setCommissionAmount(java.lang.Double commissionAmount)
          Sets commissionAmount
 void setCompanyCode(java.lang.String companyCode)
          Sets companyCode
 void setCurrentProcessingMode(java.lang.String currentProcessingMode)
          Sets currentProcessingMode
 void setNextCashBoxId(java.lang.String nextCashBoxId)
          Sets nextCashBoxId
 void setNextEventId(java.lang.String nextEventId)
          Sets nextEventId
 void setNotificationTargetBranchCode(java.lang.String notificationTargetBranchCode)
          Sets notificationTargetBranchCode
 void setProcessingDate(java.lang.String processingDate)
          Sets processingDate
 void setProcessingDateRolloverTime(java.lang.String processingDateRolloverTime)
          Sets processingDateRolloverTime
 void setProcessingMode(java.lang.String processingMode)
          Sets processingMode
 void setTimeZoneDifference(java.lang.Double timeZoneDifference)
          Sets timeZoneDifference
 com.bankframe.bo.DataPacket toDataPacket()
          Creates dataPacket for Branch
 java.lang.String toString()
          Converts DataPacket to String
 void updateBranchControlNumber(java.lang.String journalEntryId)
          Updates branchControlNumber
 
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

branchStatus

public java.lang.String branchStatus

branchName

public java.lang.String branchName

processingMode

public java.lang.String processingMode

currentProcessingMode

public java.lang.String currentProcessingMode

processingDateRolloverTime

public java.lang.String processingDateRolloverTime

timeZoneDifference

public java.lang.Double timeZoneDifference

processingDate

public java.lang.String processingDate

branchOpen

public java.lang.String branchOpen

commissionAmount

public java.lang.Double commissionAmount

nextCashBoxId

public java.lang.String nextCashBoxId

branchControlNumber

public java.lang.String branchControlNumber

nextEventId

public java.lang.String nextEventId

notificationTargetBranchCode

public java.lang.String notificationTargetBranchCode

MAPPING

public static java.util.HashMap MAPPING

PK_ATTRBUTES

public static java.util.ArrayList PK_ATTRBUTES
Constructor Detail

Branch

public Branch()
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

getBranchStatus

public java.lang.String getBranchStatus()
Returns branchStatus
Returns:
the value of branchStatus

getBranchName

public java.lang.String getBranchName()
Returns branchName
Returns:
the value of branchName

getProcessingMode

public java.lang.String getProcessingMode()
Returns processingMode
Returns:
the value of processingMode

getCurrentProcessingMode

public java.lang.String getCurrentProcessingMode()
Returns currentProcessingMode
Returns:
the value of currentProcessingMode

getProcessingDateRolloverTime

public java.lang.String getProcessingDateRolloverTime()
Returns processingDateRolloverTime
Returns:
the value of processingDateRolloverTime

getTimeZoneDifference

public java.lang.Double getTimeZoneDifference()
Returns timeZoneDifference
Returns:
the value of timeZoneDifference

getProcessingDate

public java.lang.String getProcessingDate()
Returns processingDate
Returns:
the value of processingDate

getBranchOpen

public java.lang.String getBranchOpen()
Returns branchOpen
Returns:
the value of branchOpen

getCommissionAmount

public java.lang.Double getCommissionAmount()
Returns commissionAmount
Returns:
the value of commissionAmount

getNextCashBoxId

public java.lang.String getNextCashBoxId()
Returns nextCashBoxId
Returns:
the value of nextCashBoxId

getBranchControlNumber

public java.lang.String getBranchControlNumber()
Returns branchControlNumber
Returns:
the value of branchControlNumber

getNextEventId

public java.lang.String getNextEventId()
Returns nextEventId
Returns:
the value of nextEventId

getNotificationTargetBranchCode

public java.lang.String getNotificationTargetBranchCode()
Returns notificationTargetBranchCode
Returns:
the value of notificationTargetBranchCode

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

setBranchStatus

public void setBranchStatus(java.lang.String branchStatus)
Sets branchStatus
Parameters:
branchStatus - String

setBranchName

public void setBranchName(java.lang.String branchName)
Sets branchName
Parameters:
branchName - String

setProcessingMode

public void setProcessingMode(java.lang.String processingMode)
Sets processingMode
Parameters:
processingMode - String

setCurrentProcessingMode

public void setCurrentProcessingMode(java.lang.String currentProcessingMode)
Sets currentProcessingMode
Parameters:
currentProcessingMode - String

setProcessingDateRolloverTime

public void setProcessingDateRolloverTime(java.lang.String processingDateRolloverTime)
Sets processingDateRolloverTime
Parameters:
processingDateRolloverTime - String

setTimeZoneDifference

public void setTimeZoneDifference(java.lang.Double timeZoneDifference)
Sets timeZoneDifference
Parameters:
timeZoneDifference - Double

setProcessingDate

public void setProcessingDate(java.lang.String processingDate)
Sets processingDate
Parameters:
processingDate - String

setBranchOpen

public void setBranchOpen(java.lang.String branchOpen)
Sets the value of branchOpen
Parameters:
branchOpen - String

setCommissionAmount

public void setCommissionAmount(java.lang.Double commissionAmount)
Sets commissionAmount
Parameters:
commissionAmount - Double

setNextCashBoxId

public void setNextCashBoxId(java.lang.String nextCashBoxId)
Sets nextCashBoxId
Parameters:
nextCashBoxId - String

setBranchControlNumber

public void setBranchControlNumber(java.lang.String branchControlNumber)
Sets branchControlNumber
Parameters:
branchControlNumber - String

setNextEventId

public void setNextEventId(java.lang.String nextEventId)
Sets nextEventId
Parameters:
nextEventId - String

setNotificationTargetBranchCode

public void setNotificationTargetBranchCode(java.lang.String notificationTargetBranchCode)
Sets notificationTargetBranchCode
Parameters:
notificationTargetBranchCode - String

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 tableName of Branch
Specified by:
getTableName in interface Persisted
Returns:
the tableName

toDataPacket

public com.bankframe.bo.DataPacket toDataPacket()
Creates dataPacket for Branch
Specified by:
toDataPacket in interface Persisted
Returns:
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

getAllCashboxesForBranchByTypeAndCashBoxOpen

public java.util.Vector getAllCashboxesForBranchByTypeAndCashBoxOpen(java.lang.String cashBoxType,
                                                                     java.lang.String cashBoxOpen)
                                                              throws com.bankframe.ejb.ProcessingErrorException
Returns Vector of CashBoxes return CashBoxes based on Type and CashBoxOpen
Parameters:
cashBoxType - String
cashBoxOpen - String

getCashboxesForBranchByStatusAndTypeAndCashBoxMode

public java.util.Vector getCashboxesForBranchByStatusAndTypeAndCashBoxMode(java.lang.String cashBoxStatusIndicator,
                                                                           java.lang.String cashBoxType,
                                                                           java.lang.String cashBoxMode)
Returns Vector of CashBoxes
Parameters:
cashBoxStatusIndicator - String
cashBoxType - String
cashBoxMode - String
Returns:
CashBoxes based on Status, Type and Mode

getCashBoxesForBranchByStatusAndType

public java.util.Vector getCashBoxesForBranchByStatusAndType(java.lang.String cashBoxStatusIndicator,
                                                             java.lang.String cashBoxType)
                                                      throws com.bankframe.ejb.ProcessingErrorException
Returns Vector of CashBoxes and associated currency boxes
Parameters:
cashBoxStatusIndicator - String
cashBoxType - String
Returns:
all cashboxes and associated currency boxes in a Branch
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails

getBranchCurrencyTotals

public java.util.Iterator getBranchCurrencyTotals()
Returns currency totals
Returns:
all the currency totals in a Branch

checkBranchClosed

public boolean checkBranchClosed()
                          throws com.bankframe.validation.ValidationException
Checks if the Branch is closed
Returns:
boolean after checking if the Branch is closed
Throws:
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

setBranchClosed

public void setBranchClosed()
                     throws com.bankframe.validation.ValidationException
Closes Branch
Throws:
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

createBranchCurrencyTotalsSnapshotAtEndOfDay

public void createBranchCurrencyTotalsSnapshotAtEndOfDay(java.lang.String snapshotType)
                                                  throws com.bankframe.ejb.ProcessingErrorException,
                                                         com.bankframe.validation.ValidationException
Creates snapshot of the Branch Currency Totals at the End of Day.
Parameters:
snapshotType - String
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

getCashBoxesAndNegotiableInstrumentBoxesDetailsForBranchByStatusAndType

public java.util.Vector getCashBoxesAndNegotiableInstrumentBoxesDetailsForBranchByStatusAndType(java.lang.String cashBoxStatusIndicator,
                                                                                                java.lang.String cashBoxType)
                                                                                         throws com.bankframe.ejb.ProcessingErrorException,
                                                                                                com.bankframe.validation.ValidationException
Returns Vector of CashBoxes and associated NegotiableInstrumentBoxes and NegotiableInstruments
Parameters:
cashBoxStstusIndicator - String
cashBoxType - String
Returns:
all CashBoxes and associated NegotiableInstrumentBoxes and NegotiableInstruments for a Branch
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

checkModeAndDate

public java.lang.Boolean checkModeAndDate()
                                   throws com.bankframe.ejb.ProcessingErrorException,
                                          com.bankframe.validation.ValidationException
Checks to see that the processing mode on the Branch is AM/PM and that the processing date on the Branch is equal to the system date.
Returns:
Boolean after checking that the processing mode on the Branch is AM/PM and that the processing date on the Branch is equal to the system date
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

checkCurrentProcessingMode

public java.lang.Boolean checkCurrentProcessingMode()
                                             throws com.bankframe.validation.ValidationException,
                                                    com.bankframe.ejb.ProcessingErrorException
Checks that for a Branch working in AM/PM mode that the current processing mode for the Branch is AM when they are undertaking their Branch End of Business Day operation
Returns:
Boolean after checking that for a Branch working in AM/PM mode the current processing mode for the Branch is AM when they are undertaking their Branch End of Business Day operation
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

areAllTellerEndOfBusinessDaysComplete

public java.lang.Boolean areAllTellerEndOfBusinessDaysComplete()
                                                        throws com.bankframe.ejb.ProcessingErrorException,
                                                               com.bankframe.validation.ValidationException
Checks to see that all Tellers have completed their Teller End of Business Day transaction.
Returns:
Boolean after checking that all Tellers have completed their Teller End of Business Day transaction
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

getAllCurrencyBoxDenominationSnapshotsForBranchBySnapshotTypeAndDate

public java.util.Vector getAllCurrencyBoxDenominationSnapshotsForBranchBySnapshotTypeAndDate(java.lang.String snapshotType,
                                                                                             java.lang.String date)
                                                                                      throws com.bankframe.ejb.ProcessingErrorException,
                                                                                             com.bankframe.validation.ValidationException
Returns all currency box denomination snapshots
Parameters:
snapshotType - String
date - String
Returns:
all currency box denomination snapshots for a Branch which match the search criteria of 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

createBranchCurrencyTotalsSnapshotAtEndOfBusinessDay

public void createBranchCurrencyTotalsSnapshotAtEndOfBusinessDay(java.lang.String snapshotType,
                                                                 java.util.Vector runningTotals,
                                                                 java.util.Vector notesTotals,
                                                                 java.util.Vector coinTotals,
                                                                 java.util.Vector currencys)
                                                          throws com.bankframe.ejb.ProcessingErrorException,
                                                                 com.bankframe.validation.ValidationException
Creates a snapshot of the Branch Currency Totals at the End of the Business Day.
Parameters:
snapshotType - String
runningTotal - Vector
notesTotal - Vector
coinTotal - Vector
currencys - Vector
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

updateBranchControlNumber

public void updateBranchControlNumber(java.lang.String journalEntryId)
                               throws com.bankframe.ejb.ProcessingErrorException,
                                      com.bankframe.validation.ValidationException
Updates branchControlNumber
Parameters:
journalEntryId - String
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails
com.bankframe.validation.ValidationException - This exception is thrown if validation fails