com.crm.businessobject.financialtransactions

Class CRMBORefundBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.financialtransactions.CRMBOFinancialTransactionBean

com.crm.businessobject.financialtransactions.CRMBORefundBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBORefundBean
extends CRMBOFinancialTransactionBean

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBORefundBean() 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 refund.
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, java.util.ArrayList<java.lang.String> assocations) Loads the refund based on an Accounts Receivable
com.crm.dataobject.financialtransactions.CRMDORefund	loadByBackOfficeCode(java.lang.String backOfficeCode) Loads a refund by a back office code.
com.crm.dataobject.financialtransactions.CRMDORefund	loadByBackOfficeCode(java.lang.String backOfficeCode, java.util.ArrayList<java.lang.String> associations) Loads a refund by a back office code.
com.crm.dataobject.financialtransactions.CRMDORefund	loadByNumber(java.lang.String number) Loads a refund by a number.
com.crm.dataobject.financialtransactions.CRMDORefund	loadByNumber(java.lang.String number, java.util.ArrayList<java.lang.String> associations) Loads a refund by a number.
com.crm.dataobject.financialtransactions.CRMDORefund	loadByReferenceNumber(java.lang.String refernceNumber) Loads a refund based on reference number.
com.crm.dataobject.financialtransactions.CRMDORefund	loadByReferenceNumber(java.lang.String refernceNumber, java.util.ArrayList<java.lang.String> associations) Loads a refund based on reference number.
com.crm.dataobject.financialtransactions.CRMDORefund	post(com.crm.dataobject.financialtransactions.CRMDORefund refund) Posts refund.
com.crm.dataobject.financialtransactions.CRMDORefund	post(com.crm.dataobject.financialtransactions.CRMDORefund refund, com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod) Posts refund.
com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction	reject(com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction finTransaction, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionRejectionReason rejectionReason) Rejects a draft financial transaction.

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

CRMBORefundBean

public CRMBORefundBean()

Default constructor.

Method Detail

getDefaultAssociations

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

Gets the default association data objects of the refund.

Overrides:

getDefaultAssociations in class CRMBOFinancialTransactionBean

Returns:

a list of data objects associated to the refund

post

public com.crm.dataobject.financialtransactions.CRMDORefund post(com.crm.dataobject.financialtransactions.CRMDORefund refund)
                                                          throws java.lang.Exception,
                                                                 com.crm.exception.financialtransactions.FTPostException,
                                                                 com.crm.exception.financialtransactions.CannotRefundException

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

Parameters:

refund - a refund

Returns:

the updated refund

Throws:

java.lang.Exception

com.crm.exception.financialtransactions.FTPostException

com.crm.exception.financialtransactions.CannotRefundException

post

public com.crm.dataobject.financialtransactions.CRMDORefund post(com.crm.dataobject.financialtransactions.CRMDORefund refund,
                                                                 com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod)
                                                          throws java.lang.Exception,
                                                                 com.crm.exception.financialtransactions.FTPostException,
                                                                 com.crm.exception.financialtransactions.CannotRefundException

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

Parameters:

refund - a refund

accountingPeriod - the open accounting period

Returns:

the updated refund

Throws:

java.lang.Exception

com.crm.exception.financialtransactions.FTPostException

com.crm.exception.financialtransactions.CannotRefundException

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 draft financial transaction.

Overrides:

reject in class CRMBOFinancialTransactionBean

Parameters:

finTransaction - a financial transaction (required)

rejectionReason - a rejection reason (required)

Returns:

the updated financial transaction

Throws:

java.lang.Exception

com.crm.exception.financialtransactions.InvalidStateRejectionException

com.crm.exception.financialtransactions.FinTransactionRejectionException

loadByNumber

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

Loads a refund by a number.

Parameters:

number - a refund number (required)

Returns:

the refund with specified number

Throws:

java.lang.Exception

loadByNumber

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

Loads a refund by a number.

Parameters:

number - a refund number (required)

associations - the associate objects you want to initialize

Returns:

the refund with specified number

Throws:

java.lang.Exception

loadByReferenceNumber

public com.crm.dataobject.financialtransactions.CRMDORefund loadByReferenceNumber(java.lang.String refernceNumber)
                                                                           throws java.lang.Exception

Loads a refund based on reference number.

Parameters:

refernceNumber - a refund reference number (required)

Returns:

the refund with specified reference number

Throws:

java.lang.Exception

loadByReferenceNumber

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

Loads a refund based on reference number.

Parameters:

refernceNumber - a refund reference number (required)

associations - the associate objects you want to initialize

Returns:

the payment with specified reference number

Throws:

java.lang.Exception

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,
                                                          java.util.ArrayList<java.lang.String> assocations)
                                                   throws java.lang.Exception

Loads the refund based on an Accounts Receivable

Parameters:

accountReceivable - a financial account (required)

type - a financial transaction type (optional)

category - a financial transaction category (optional)

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

Returns:

a list of refunds

Throws:

java.lang.Exception

loadByBackOfficeCode

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

Loads a refund by a back office code.

Parameters:

backOfficeCode - a back office code

Returns:

the refund with specified back office code

Throws:

java.lang.Exception

loadByBackOfficeCode

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

Loads a refund by a back office code.

Parameters:

backOfficeCode - a back office code

associations - a list of associations

Returns:

the refund with specified back office code

Throws:

java.lang.Exception