com.crm.businessobject.financialtransactions

Class CRMBOFinancialTransactionBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.financialtransactions.CRMBOFinancialTransactionBean

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CRMBOCreditNoteBean, CRMBOInvoiceBean, CRMBOInvoiceCancellationBean, CRMBOPaymentBean, CRMBOPaymentCancellationBean, CRMBORefundBean

public class CRMBOFinancialTransactionBean
extends CRMBO

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOFinancialTransactionBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction	calculateAmounts(com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction finTransaction) Calculates amount for a financial transaction.
com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction	calculateAmountsFromTotals(com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction finTransaction) Calculates amounts from total for a financial transaction.
com.crm.dataobject.CRMDO	construct(com.crm.dataobject.CRMDO mainDTO) Overwrite the construct method in order to initialize the customer events of all type
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Gets the default association data objects of the financial transaction.
java.util.Date	getMinimumPostedDate() Retrieves the Minimum Posted Date
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod) Loads a list of financial transactions based on the given accounting period.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionCategory category, com.crm.dataobject.financialtransactions.FinancialTransactionLifeCycleState lifeCycleState) Loads a list of financial transactions based on the given parameters.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(java.lang.String accountReceivable, com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod, java.util.Date asOfDate) Load all financial transactions which were posted during the accounting period being closed
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadNonPosted(com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod) Loads a list of non posted financial transactions
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadNonPostedTransactionsWithAccountPeriod() Find all financial transactions which: -Not in Posted state -Have a related Accounting Period
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadPostedTransactionsWithoutAccountPeriod(java.util.Date openAccountingPeriodFromDate) Find all financial transactions which: -Are not related to any accounting period and -Are in Posted life cycle state and -Their posting date is before the accounting period's start date (exclusive)
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadTransactionsWithInvalidAccountPeriod(java.util.Date asOfDate) Load all financial transactions which are posted and belongs to invalid accounting period
com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction	reject(com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction finTransaction, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionRejectionReason rejectionReason) Rejects a draft financial transaction.
com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction	setVaPercentage(com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction finTransaction) Sets the vat percentage of a financial transaction

Methods inherited from class com.crm.businessobject.CRMBO

construct, construct, construct, construct, construct, construct, construct, construct, createAndUpdate, delete, delete, delete, getDOName, getDOName, getNextSequenceNumber, getNextSequenceNumber, getNumberScheme, isAssignable, load, load, load, load, load, load, load, load, load, loadAll, loadAll, loadAll, loadAllEntityStatusDO, loadAllEntityStatusDO, loadDataObject, loadDataObject, loadDataObject, loadDataObjects, loadEntityCategoryDO, loadEntityCategoryDO, loadEntityDO, loadEntityDO, loadEntityStatusDO, loadEntityStatusDO, parseAssociations, parseAssociations, save, save, save, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, validateApprovalRequestEntity, validateFormatSettings, validateFormatSettings, validateOnDelete, validateOnDelete, validateOnDelete, validateOnSave, validateOnSave, validateOnSave

Methods inherited from class com.crm.businessobject.CRMBase

deepCopy, dispatch, getCRMSession, getCRMSessionHandle, getCurrentDate, getEJBHomeInterface, getInitialContext, getSessionContext, invoke, setCRMSessionHandle, setInitialContext, setSessionContext

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CRMBOFinancialTransactionBean

public CRMBOFinancialTransactionBean()

Default constructor.

Method Detail

construct

public com.crm.dataobject.CRMDO construct(com.crm.dataobject.CRMDO mainDTO)
                                   throws java.lang.Exception

Overwrite the construct method in order to initialize the customer events of all type

Overrides:

construct in class CRMBO

Parameters:

mainDTO - - the data object to construct

Returns:

the constructed data object

Throws:

java.lang.Exception

getDefaultAssociations

public java.util.ArrayList<java.lang.String> getDefaultAssociations()

Gets the default association data objects of the financial transaction.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

a list of data objects associated to the financial transaction

reject

public com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction reject(com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction finTransaction,
                                                                                 com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionRejectionReason rejectionReason)
                                                                          throws java.lang.Exception

Rejects a draft financial transaction.

Parameters:

finTransaction - a financial transaction (required)

rejectionReason - a rejection reason (required)

Returns:

the updated financial transaction

Throws:

java.lang.Exception

calculateAmounts

public com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction calculateAmounts(com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction finTransaction)
                                                                                    throws java.lang.Exception

Calculates amount for a financial transaction.

Parameters:

finTransaction - a financial transaction

Returns:

the financial transaction updated with the discount, vat, net and total amounts.

Throws:

java.lang.Exception

calculateAmountsFromTotals

public com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction calculateAmountsFromTotals(com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction finTransaction)
                                                                                              throws java.lang.Exception

Calculates amounts from total for a financial transaction.

Parameters:

finTransaction - a financial transaction

Returns:

the financial transaction updated with the discount, vat, net and total amounts.

Throws:

java.lang.Exception

setVaPercentage

public com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction setVaPercentage(com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction finTransaction)
                                                                                   throws java.lang.Exception

Sets the vat percentage of a financial transaction

Parameters:

finTransaction - - the financial transaction to update

Returns:

finTransaction - the updated financial transaction

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionCategory category,
                                                          com.crm.dataobject.financialtransactions.FinancialTransactionLifeCycleState lifeCycleState)
                                                   throws java.lang.Exception

Loads a list of financial transactions based on the given parameters.

Parameters:

category - - the financial transaction category

lifeCycleState - - the life cycle state

Returns:

a list of financial transactions

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod)
                                                   throws java.lang.Exception

Loads a list of financial transactions based on the given accounting period.

Parameters:

accountingPeriod - - the accounting period

Returns:

a list of financial transactions

Throws:

java.lang.Exception

loadNonPosted

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadNonPosted(com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod)
                                                            throws java.lang.Exception

Loads a list of non posted financial transactions

Returns:

a list of non posted financial transactions

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(java.lang.String accountReceivable,
                                                          com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod,
                                                          java.util.Date asOfDate)
                                                   throws java.lang.Exception

Load all financial transactions which were posted during the accounting period being closed

Parameters:

accountReceivable - - the account receivable id of which the financial transaction will be loaded

accountingPeriod - - the transactions posted in the specified accounting period should be retrieve

asOfDate - - the transactions with created date less or equal to as of date should be retrieve

Returns:

a list of all financial transactions which were posted during the accounting period being closed

Throws:

java.lang.Exception

loadTransactionsWithInvalidAccountPeriod

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadTransactionsWithInvalidAccountPeriod(java.util.Date asOfDate)
                                                                                       throws java.lang.Exception

Load all financial transactions which are posted and belongs to invalid accounting period

Parameters:

asOfDate - - the transactions with created date less or equal to as of date should be retrieve

Returns:

a list of all financial transactions which are posted and belongs to invalid accounting period

Throws:

java.lang.Exception

loadPostedTransactionsWithoutAccountPeriod

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadPostedTransactionsWithoutAccountPeriod(java.util.Date openAccountingPeriodFromDate)
                                                                                         throws java.lang.Exception

Find all financial transactions which: -Are not related to any accounting period and -Are in Posted life cycle state and -Their posting date is before the accounting period's start date (exclusive)

Parameters:

openAccountingPeriodFromDate - - the transactions with created date less or equal to as of date should be retrieve

Returns:

a list of financial transactions full fill the criteria

Throws:

java.lang.Exception

loadNonPostedTransactionsWithAccountPeriod

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadNonPostedTransactionsWithAccountPeriod()
                                                                                         throws java.lang.Exception

Find all financial transactions which: -Not in Posted state -Have a related Accounting Period

Returns:

a list of financial transactions full fill the criteria

Throws:

java.lang.Exception

getMinimumPostedDate

public java.util.Date getMinimumPostedDate()
                                    throws java.lang.Exception

Retrieves the Minimum Posted Date

Returns:

the Minimum Posted Date

Throws:

java.lang.Exception