com.crm.businessobject.financialtransactions

Class CRMBOPaymentCancellationBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.financialtransactions.CRMBOFinancialTransactionBean

com.crm.businessobject.financialtransactions.CRMBOPaymentCancellationBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOPaymentCancellationBean
extends CRMBOFinancialTransactionBean

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOPaymentCancellationBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Gets the default association data objects of the payment cancellation.
com.crm.dataobject.financialtransactions.CRMDOPaymentCancellation	load(com.crm.dataobject.financialtransactions.CRMDOPayment payment) Loads a payment cancellation based on payment.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.financialtransactions.FinancialTransactionLifeCycleState lifeCycleState, java.lang.Boolean relatedWithPaymentGateway) Loads a list of financial transactions based on the given parameters.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadPending(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation, java.util.ArrayList<java.lang.String> associations) Find all financial transactions which: - in Draft or Pending Verification state
com.crm.dataobject.financialtransactions.CRMDOPaymentCancellation	post(com.crm.dataobject.financialtransactions.CRMDOPaymentCancellation paymentCancellation) Posts payment cancellation.
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.
void	validatePosting(com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction financialTransaction, java.util.Date postedDate, com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod) Validates if financial transaction can be posted

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

anonymizeContactFT, calculateAmounts, calculateAmounts, calculateAmountsFromTotals, calculateAmountsFromTotals, construct, getMinimumPostedDate, load, load, load, loadNonPosted, loadNonPostedTransactionsWithAccountPeriod, loadPostedTransactionsWithoutAccountPeriod, loadTransactionsWithInvalidAccountPeriod, setTaxPercentage, setVaPercentage, setVaPercentage, setVatInformation, setVatInformation

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, load, load, load, load, load, loadAll, loadAll, loadAll, loadAllEntityStatusDO, loadAllEntityStatusDO, loadDataObject, loadDataObject, loadDataObject, loadDataObjects, loadDataObjects, loadEntityCategoryDO, loadEntityCategoryDO, loadEntityDO, loadEntityDO, loadEntityStatusDO, loadEntityStatusDO, parseAssociations, 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

CRMBOPaymentCancellationBean

public CRMBOPaymentCancellationBean()

Default constructor.

Method Detail

getDefaultAssociations

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

Gets the default association data objects of the payment cancellation.

Overrides:

getDefaultAssociations in class CRMBOFinancialTransactionBean

Returns:

a list of data objects associated to the payment cancellation

post

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

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

Parameters:

paymentCancellation - a payment cancellation (required)

Returns:

the updated payment cancellation

Throws:

java.lang.Exception

com.crm.exception.financialtransactions.FTPostException

validatePosting

public void validatePosting(com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction financialTransaction,
                            java.util.Date postedDate,
                            com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod)
                     throws java.lang.Exception,
                            com.crm.exception.financialtransactions.InvalidAccountStateException

Validates if financial transaction can be posted

Overrides:

validatePosting in class CRMBOFinancialTransactionBean

Parameters:

financialTransaction - -the financial transaction to validate id it can be posted

postedDate - -the posted date of the financial transaction

accountingPeriod - -the open accounting period data object

Throws:

com.crm.exception.financialtransactions.InvalidAccountStateException

java.lang.Exception

load

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

Loads a payment cancellation based on payment.

Parameters:

payment - a payment (required)

Returns:

a payment cancellation with specified payment

Throws:

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

loadPending

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadPending(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation,
                                                                 java.util.ArrayList<java.lang.String> associations)
                                                          throws java.lang.Exception

Find all financial transactions which: - in Draft or Pending Verification state

Returns:

a list of financial transactions full fill the criteria

Throws:

java.lang.Exception

load

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

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

Parameters:

lifeCycleState - - the financial transaction life cycle state

relatedWithPaymentGateway - - a flag indicating whether retrieved financial transactions should be related with a payment gateway

Returns:

a list of financial transactions

Throws:

java.lang.Exception