com.siebel.rf.offline.data.batch
Class Batch

java.lang.Object
  |
  +--com.siebel.rf.offline.data.batch.Batch

All Implemented Interfaces:

Persisted

public class Batch

extends java.lang.Object

implements Persisted

The Batch persisted class

Field Summary

java.lang.Double	batchAmount
java.lang.String	batchDate
java.lang.String	batchId
java.lang.String	batchStatus
java.lang.String	branchCode
java.lang.String	cashBoxId
java.lang.String	companyCode
java.lang.String	currency
java.lang.String	documentType
static java.util.HashMap	MAPPING
java.lang.String	numberOfNegotiableInstruments
static java.util.ArrayList	PK_ATTRIBUTES
java.lang.String	userId

Constructor Summary

Batch()

Method Summary

void	addNegotiableInstrument(com.bankframe.vo.retail.solutionset.impl.financialtransactions.FinancialTransactionNegotiableInstrumentVO financialTransactionNegotiableInstrumentVO) Adds negotiable instrument to a batch.
void	close() Sets status of the batch to Closed.
boolean	equals(java.lang.Object object) Compares object.
java.lang.Double	getBatchAmount() Returns batchAmount
java.lang.String	getBatchDate() Returns batchDate
java.lang.String	getBatchId() Returns batchId
java.lang.String	getBatchState() Returns batchState.
java.lang.String	getBatchStatus() Returns batchStatus
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.lang.String	getDocumentType() Returns documentType
java.util.HashMap	getMapping() Returns attributes vs.
java.lang.String	getNumberOfNegotiableInstruments() Returns numberOfNegotiableInstruments
java.util.ArrayList	getPKAttributes() Returns collection of primary key attributes
java.lang.String	getTableName() Returns tableName of Batch
java.lang.String	getUserId() Returns userId
void	setBatchAmount(java.lang.Double batchAmount) Sets batchAmount
void	setBatchDate(java.lang.String batchDate) Sets batchDate
void	setBatchId(java.lang.String batchId) Sets batchId
void	setBatchStatus(java.lang.String batchStatus) Sets batchStatus
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	setDocumentType(java.lang.String documentType) Sets documentType
void	setNumberOfNegotiableInstruments(java.lang.String numberOfNegotiableInstruments) Sets numberOfNegotiableInstruments
void	setUserId(java.lang.String userId) Sets userId
com.bankframe.bo.DataPacket	toDataPacket() Creates dataPacket of Batch
java.lang.String	toString() Converts DataPacket to String.
void	updateBatchUserId(java.lang.String userId) Updates userId for the batch.

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

batchId

public java.lang.String batchId

batchDate

public java.lang.String batchDate

cashBoxId

public java.lang.String cashBoxId

userId

public java.lang.String userId

numberOfNegotiableInstruments

public java.lang.String numberOfNegotiableInstruments

batchAmount

public java.lang.Double batchAmount

currency

public java.lang.String currency

batchStatus

public java.lang.String batchStatus

documentType

public java.lang.String documentType

MAPPING

public static java.util.HashMap MAPPING

PK_ATTRIBUTES

public static java.util.ArrayList PK_ATTRIBUTES

Constructor Detail

Batch

public Batch()

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

getBatchId

public java.lang.String getBatchId()

Returns batchId

Returns:

the value of batchId

getBatchDate

public java.lang.String getBatchDate()

Returns batchDate

Returns:

the value of batchDate

getCashBoxId

public java.lang.String getCashBoxId()

Returns cashBoxId

Returns:

the value of cashBoxId

getUserId

public java.lang.String getUserId()

Returns userId

Returns:

the value of UserId

getNumberOfNegotiableInstruments

public java.lang.String getNumberOfNegotiableInstruments()

Returns numberOfNegotiableInstruments

Returns:

the value of numberOfNegotiableInstruments

getBatchAmount

public java.lang.Double getBatchAmount()

Returns batchAmount

Returns:

the value of batchAmount

getCurrency

public java.lang.String getCurrency()

Returns currency

Returns:

the value of currency

getBatchStatus

public java.lang.String getBatchStatus()

Returns batchStatus

Returns:

the value of batchStatus

getDocumentType

public java.lang.String getDocumentType()

Returns documentType

Returns:

the value of documentType

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

setBatchId

public void setBatchId(java.lang.String batchId)

Sets batchId

Parameters:

batchId - String

setcashBoxId

public void setcashBoxId(java.lang.String cashBoxId)

Sets cashBoxId

Parameters:

cashBoxId - String

setUserId

public void setUserId(java.lang.String userId)

Sets userId

Parameters:

userId - String

setNumberOfNegotiableInstruments

public void setNumberOfNegotiableInstruments(java.lang.String numberOfNegotiableInstruments)

Sets numberOfNegotiableInstruments

Parameters:

numberOfNegotiableInstruments - String

setBatchAmount

public void setBatchAmount(java.lang.Double batchAmount)

Sets batchAmount

Parameters:

batchAmount - Double

setCurrency

public void setCurrency(java.lang.String currency)

Sets currency

Parameters:

currency - String

setBatchStatus

public void setBatchStatus(java.lang.String batchStatus)

Sets batchStatus

Parameters:

batchStatus - String

setBatchDate

public void setBatchDate(java.lang.String batchDate)

Sets batchDate

Parameters:

batchDate - String

setDocumentType

public void setDocumentType(java.lang.String documentType)

Sets documentType

Parameters:

documentType - 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 Batch

Specified by:

getTableName in interface Persisted

Returns:

the tableName

toDataPacket

public com.bankframe.bo.DataPacket toDataPacket()

Creates dataPacket of Batch

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

updateBatchUserId

public void updateBatchUserId(java.lang.String userId)
                       throws com.bankframe.validation.ValidationException

Updates userId for the batch.

Parameters:

userId - String

Throws:

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

addNegotiableInstrument

public void addNegotiableInstrument(com.bankframe.vo.retail.solutionset.impl.financialtransactions.FinancialTransactionNegotiableInstrumentVO financialTransactionNegotiableInstrumentVO)
                             throws com.bankframe.ejb.ProcessingErrorException,
                                    com.bankframe.validation.ValidationException

Adds negotiable instrument to a batch.

Parameters:

financialTransactionNegotiableInstrument - FinancialTransactionNegotiableInstrument

Throws:

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

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

getBatchState

public java.lang.String getBatchState()
                               throws com.bankframe.ejb.ProcessingErrorException,
                                      com.bankframe.validation.ValidationException

Returns batchState.

Returns:

batchState after checking if a batch has reached its limits

Throws:

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

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

close

public void close()
           throws com.bankframe.validation.ValidationException

Sets status of the batch to Closed.

Throws:

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