com.crm.businessobject.financialtransactions

Class CRMBOPaymentBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.financialtransactions.CRMBOFinancialTransactionBean

com.crm.businessobject.financialtransactions.CRMBOPaymentBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOPaymentBean
extends CRMBOFinancialTransactionBean

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOPaymentBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
com.crm.dataobject.financialtransactions.CRMDOPayment	cancel(com.crm.dataobject.financialtransactions.CRMDOPayment payment) Cancels a payment.
java.math.BigDecimal	getAllocatedAmount(com.crm.dataobject.financialtransactions.CRMDOPayment payment) Gets the allocated amount for a payment.
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Gets the default association data objects of the payment.
java.lang.Boolean	isCancelled(com.crm.dataobject.financialtransactions.CRMDOPayment payment) Checks if a payment is cancelled or not
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType type, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionCategory category, com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod, java.util.ArrayList<java.lang.String> assocations, java.lang.String orderBy, com.crm.dataobject.financialtransactions.FinancialTransactionLifeCycleState lifeCycleState) Loads the payments based on an Accounts Receivable
com.crm.dataobject.financialtransactions.CRMDOPayment	load(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Loads payment based on voucher.
com.crm.dataobject.financialtransactions.CRMDOPayment	load(com.crm.dataobject.vouchers.CRMDOVoucher voucher, java.util.ArrayList<java.lang.String> associations) Loads payment based on voucher.
com.crm.dataobject.financialtransactions.CRMDOPayment	loadByBackOfficeCode(java.lang.String backOfficeCode) Loads a payment by a back office code.
com.crm.dataobject.financialtransactions.CRMDOPayment	loadByBackOfficeCode(java.lang.String backOfficeCode, java.util.ArrayList<java.lang.String> associations) Loads a payment by a back office code.
com.crm.dataobject.financialtransactions.CRMDOPayment	loadByNumber(java.lang.String number) Loads a payment by a number.
com.crm.dataobject.financialtransactions.CRMDOPayment	loadByNumber(java.lang.String number, java.util.ArrayList<java.lang.String> associations) Loads a payment by a number.
com.crm.dataobject.financialtransactions.CRMDOPayment	loadByReferenceNumber(java.lang.String referenceNumber) Loads a payment based on reference number.
com.crm.dataobject.financialtransactions.CRMDOPayment	loadByReferenceNumber(java.lang.String referenceNumber, java.util.ArrayList<java.lang.String> associations) Loads a payment based on reference number.
com.crm.dataobject.financialtransactions.CRMDOPayment	post(com.crm.dataobject.financialtransactions.CRMDOPayment payment) Posts payment.
com.crm.dataobject.financialtransactions.CRMDOPayment	post(com.crm.dataobject.financialtransactions.CRMDOPayment payment, com.crm.dataobject.platform.CRMDONumberScheme numberScheme) Posts payment.
com.crm.dataobject.financialtransactions.CRMDOPayment	post(com.crm.dataobject.financialtransactions.CRMDOPayment payment, com.crm.dataobject.platform.CRMDONumberScheme numberScheme, com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod) Posts payment.
com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction	reject(com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction finTransaction, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionRejectionReason rejectionReason) Rejects a financial transaction based on the parameters.
com.crm.dataobject.financialtransactions.CRMDOPayment	roundTotalAmount(com.crm.dataobject.financialtransactions.CRMDOPayment payment) Calculates rounded total amount.
void	validatePaymentMethodOnPosting(com.crm.dataobject.financialtransactions.CRMDOPayment payment) Validates the payment method on post

Methods inherited from class com.crm.businessobject.financialtransactions.CRMBOFinancialTransactionBean

calculateAmounts, calculateAmountsFromTotals, construct, getMinimumPostedDate, load, load, load, loadNonPosted, loadNonPostedTransactionsWithAccountPeriod, loadPostedTransactionsWithoutAccountPeriod, loadTransactionsWithInvalidAccountPeriod, setVaPercentage

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

CRMBOPaymentBean

public CRMBOPaymentBean()

Default constructor.

Method Detail

getDefaultAssociations

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

Gets the default association data objects of the payment.

Overrides:

getDefaultAssociations in class CRMBOFinancialTransactionBean

Returns:

a list of data objects associated to the payment

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType type,
                                                          com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionCategory category,
                                                          com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod,
                                                          java.util.ArrayList<java.lang.String> assocations,
                                                          java.lang.String orderBy,
                                                          com.crm.dataobject.financialtransactions.FinancialTransactionLifeCycleState lifeCycleState)
                                                   throws java.lang.Exception

Loads the payments based on an Accounts Receivable

Parameters:

accountReceivable - an Accounts Receivable (required)

type - a financial transaction type (optional)

category - a financial transaction category (optional)

paymentMethod - a financial transaction payment method (optional)

assocations - the associate object you want to initialize(optional)

lifeCycleState - the life cycle state of the payment(optional)

orderBy - the order by field(optional)

Returns:

a list of payments

Throws:

java.lang.Exception

loadByNumber

public com.crm.dataobject.financialtransactions.CRMDOPayment loadByNumber(java.lang.String number)
                                                                   throws java.lang.Exception

Loads a payment by a number.

Parameters:

number - a payment number (required)

Returns:

the payment with specified number

Throws:

java.lang.Exception

loadByNumber

public com.crm.dataobject.financialtransactions.CRMDOPayment loadByNumber(java.lang.String number,
                                                                          java.util.ArrayList<java.lang.String> associations)
                                                                   throws java.lang.Exception

Loads a payment by a number.

Parameters:

number - a payment number (required)

associations - the associate objects you want to initialize

Returns:

the payment with specified number

Throws:

java.lang.Exception

loadByReferenceNumber

public com.crm.dataobject.financialtransactions.CRMDOPayment loadByReferenceNumber(java.lang.String referenceNumber)
                                                                            throws java.lang.Exception

Loads a payment based on reference number.

Parameters:

referenceNumber - a payment reference number (required)

Returns:

the payment with specified reference number

Throws:

java.lang.Exception

loadByReferenceNumber

public com.crm.dataobject.financialtransactions.CRMDOPayment loadByReferenceNumber(java.lang.String referenceNumber,
                                                                                   java.util.ArrayList<java.lang.String> associations)
                                                                            throws java.lang.Exception

Loads a payment based on reference number.

Parameters:

referenceNumber - a payment reference number (required)

associations - the associate objects you want to initialize

Returns:

the payment with specified reference number

Throws:

java.lang.Exception

post

public com.crm.dataobject.financialtransactions.CRMDOPayment post(com.crm.dataobject.financialtransactions.CRMDOPayment payment)
                                                           throws java.lang.Exception,
                                                                  com.crm.exception.financialtransactions.FTPostException

Posts payment. (Sets posted date, generates transaction number, performs allocations).

Parameters:

payment - a payment (required)

Returns:

the updated payment

Throws:

java.lang.Exception

com.crm.exception.financialtransactions.FTPostException

post

public com.crm.dataobject.financialtransactions.CRMDOPayment post(com.crm.dataobject.financialtransactions.CRMDOPayment payment,
                                                                  com.crm.dataobject.platform.CRMDONumberScheme numberScheme)
                                                           throws java.lang.Exception,
                                                                  com.crm.exception.financialtransactions.FTPostException

Posts payment. (Sets posted date, generates transaction number, performs allocations).

Parameters:

payment - a payment (required)

numberScheme - the number scheme of the payment(optional)

Returns:

the updated payment

Throws:

java.lang.Exception

com.crm.exception.financialtransactions.FTPostException

post

public com.crm.dataobject.financialtransactions.CRMDOPayment post(com.crm.dataobject.financialtransactions.CRMDOPayment payment,
                                                                  com.crm.dataobject.platform.CRMDONumberScheme numberScheme,
                                                                  com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod)
                                                           throws java.lang.Exception,
                                                                  com.crm.exception.financialtransactions.FTPostException

Posts payment. (Sets posted date, generates transaction number, performs allocations).

Parameters:

payment - a payment (required)

numberScheme - the number scheme of the payment(optional)

accountingPeriod - the open accounting period

Returns:

the updated payment

Throws:

com.crm.exception.financialtransactions.FTPostException

java.lang.Exception

validatePaymentMethodOnPosting

public void validatePaymentMethodOnPosting(com.crm.dataobject.financialtransactions.CRMDOPayment payment)
                                    throws java.lang.Exception,
                                           com.crm.exception.ActionNotAllowedByApplicationServerException,
                                           com.crm.exception.paymentgateway.NoEffectivePaymentGatewayProviderExistsException

Validates the payment method on post

Parameters:

payment - - the payment to validate

Throws:

com.crm.exception.paymentgateway.NoEffectivePaymentGatewayProviderExistsException

com.crm.exception.ActionNotAllowedByApplicationServerException

java.lang.Exception

cancel

public com.crm.dataobject.financialtransactions.CRMDOPayment cancel(com.crm.dataobject.financialtransactions.CRMDOPayment payment)
                                                             throws java.lang.Exception,
                                                                    com.crm.exception.financialtransactions.FTCancelException,
                                                                    com.crm.exception.financialtransactions.FTAlreadyCancelledException

Cancels a payment. (Sets the life cycle state to draft, generates and sets the reference number and the issued date)

Parameters:

payment - a payment

Returns:

the updated payment

Throws:

com.crm.exception.financialtransactions.FTCancelException

com.crm.exception.financialtransactions.FTAlreadyCancelledException

java.lang.Exception

reject

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

Rejects a financial transaction based on the parameters.

Overrides:

reject in class CRMBOFinancialTransactionBean

Parameters:

finTransaction - the financial transaction to reject

rejectionReason - financial transaction life cycle state

Returns:

finTransaction - the rejected financial transaction

Throws:

java.lang.Exception

com.crm.exception.financialtransactions.InvalidStateRejectionException

com.crm.exception.financialtransactions.FinTransactionRejectionException

getAllocatedAmount

public java.math.BigDecimal getAllocatedAmount(com.crm.dataobject.financialtransactions.CRMDOPayment payment)
                                        throws java.lang.Exception

Gets the allocated amount for a payment.

Parameters:

payment - a payment

Returns:

a value of allocated amount

Throws:

java.lang.Exception

isCancelled

public java.lang.Boolean isCancelled(com.crm.dataobject.financialtransactions.CRMDOPayment payment)
                              throws java.lang.Exception

Checks if a payment is cancelled or not

Parameters:

payment - a payment

Returns:

true if the payment is cancelled, false if it is not

Throws:

java.lang.Exception

load

public com.crm.dataobject.financialtransactions.CRMDOPayment load(com.crm.dataobject.vouchers.CRMDOVoucher voucher)
                                                           throws java.lang.Exception

Loads payment based on voucher.

Parameters:

voucher - a voucher

Returns:

the loaded payment

Throws:

java.lang.Exception

load

public com.crm.dataobject.financialtransactions.CRMDOPayment load(com.crm.dataobject.vouchers.CRMDOVoucher voucher,
                                                                  java.util.ArrayList<java.lang.String> associations)
                                                           throws java.lang.Exception

Loads payment based on voucher.

Parameters:

voucher - a voucher

associations - a list of associations

Returns:

the loaded payment

Throws:

java.lang.Exception

roundTotalAmount

public com.crm.dataobject.financialtransactions.CRMDOPayment roundTotalAmount(com.crm.dataobject.financialtransactions.CRMDOPayment payment)
                                                                       throws java.lang.Exception

Calculates rounded total amount.

Parameters:

payment - a payment

Returns:

an updated payment

Throws:

java.lang.Exception

loadByBackOfficeCode

public com.crm.dataobject.financialtransactions.CRMDOPayment loadByBackOfficeCode(java.lang.String backOfficeCode)
                                                                           throws java.lang.Exception

Loads a payment by a back office code.

Parameters:

backOfficeCode - a back office code

Returns:

the payment with specified back office code

Throws:

java.lang.Exception

loadByBackOfficeCode

public com.crm.dataobject.financialtransactions.CRMDOPayment loadByBackOfficeCode(java.lang.String backOfficeCode,
                                                                                  java.util.ArrayList<java.lang.String> associations)
                                                                           throws java.lang.Exception

Loads a payment by a back office code.

Parameters:

backOfficeCode - a back office code

associations - a list of associations

Returns:

the payment with specified back office code

Throws:

java.lang.Exception