com.crm.businessobject.accounts

Class CRMBOPaymentPreferenceBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.CRMBOCacheableEntity

com.crm.businessobject.CRMBOConfigurationEntity

com.crm.businessobject.accounts.CRMBOPaymentPreferenceBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOPaymentPreferenceBean
extends CRMBOConfigurationEntity

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOPaymentPreferenceBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	exists(java.util.Set<com.crm.dataobject.accounts.CRMDOPaymentPreference> existingPaymentPreferences, com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference) Checks whether a payment preference exists in the given parameter list having the given parameter name and non-null parameter value
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a payment preference.
java.lang.Boolean	isIdentifierSpecified(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference) Checks if the payment preference identifier field is specified as mandatory
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Loads a list of payment preferences given the accounts receivable
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting) Loads a list of payment preferences by a payment gateway setting.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedBankAccountTypes() Returns the allowed bank account types.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedBankAccountTypes(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference) Returns the allowed bank account types of the given payment preference.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedBanks() Returns the allowed banks
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedBanks(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference) Returns the allowed banks of the given payment preference.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedPaymentMediumBrands() Returns the allowed payment medium brands.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedPaymentMediumBrands(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference) Returns the allowed payment medium brands of the given payment preference.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedPaymentMediumTypes() Returns the allowed payment medium types.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedPaymentMediumTypes(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference) Returns the allowed payment medium types of the given payment preference.
com.crm.dataobject.accounts.CRMDOPaymentPreference	loadByAltCode(java.lang.String altCode) Loads a payment preference by an alternative code.
com.crm.dataobject.accounts.CRMDOPaymentPreference	loadByAltCode(java.lang.String altCode, java.util.ArrayList<java.lang.String> associations) Loads a payment preference by an alternative code.
com.crm.dataobject.accounts.CRMDOPaymentPreference	loadByName(java.lang.String name) Loads a payment preference by a name.
com.crm.dataobject.accounts.CRMDOPaymentPreference	loadByName(java.lang.String name, java.util.ArrayList<java.lang.String> associations) Loads a payment preference by a name.
void	validateBankRelatedFieldsOnSave(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference) Validates that when bank branch is specified as supported field, bank is also specified
void	validateSupportedFieldsUniqueness(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference) Validates that each payment preference supported field exists only one time in the given list

Methods inherited from class com.crm.businessobject.CRMBOConfigurationEntity

isDefault, loadDefault, setDefault

Methods inherited from class com.crm.businessobject.CRMBO

construct, 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

CRMBOPaymentPreferenceBean

public CRMBOPaymentPreferenceBean()

Default constructor.

Method Detail

isIdentifierSpecified

public java.lang.Boolean isIdentifierSpecified(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference)

Checks if the payment preference identifier field is specified as mandatory

Parameters:

paymentPreference - - the payment preference to check

Returns:

true if is specified as mandatory, false if not

validateSupportedFieldsUniqueness

public void validateSupportedFieldsUniqueness(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference)
                                       throws java.lang.Exception,
                                              com.crm.exception.OnlyOneRecordException

Validates that each payment preference supported field exists only one time in the given list

Parameters:

paymentPreference - - the payment preference to validate its supported fields

Throws:

java.lang.Exception

com.crm.exception.OnlyOneRecordException

validateBankRelatedFieldsOnSave

public void validateBankRelatedFieldsOnSave(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference)
                                     throws com.crm.exception.accounts.PaymentPreferenceSupportedFieldsException,
                                            java.lang.Exception

Validates that when bank branch is specified as supported field, bank is also specified

Parameters:

paymentPreference - - the payment preference to validate its supported fields

Throws:

com.crm.exception.accounts.PaymentPreferenceSupportedFieldsException

java.lang.Exception

getDefaultAssociations

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

Returns the default associated data objects of a payment preference.

Overrides:

getDefaultAssociations in class CRMBOConfigurationEntity

Returns:

the default associated data objects of the payment preference

loadByAltCode

public com.crm.dataobject.accounts.CRMDOPaymentPreference loadByAltCode(java.lang.String altCode)
                                                                 throws java.lang.Exception

Loads a payment preference by an alternative code.

Parameters:

altCode - - the alternative code to load by

Returns:

a payment preference with the given alternative code

Throws:

java.lang.Exception

loadByAltCode

public com.crm.dataobject.accounts.CRMDOPaymentPreference loadByAltCode(java.lang.String altCode,
                                                                        java.util.ArrayList<java.lang.String> associations)
                                                                 throws java.lang.Exception

Loads a payment preference by an alternative code.

Parameters:

altCode - - the alternative code to load by

associations - - a list of associated objects

Returns:

a payment preference with the given alternative code

Throws:

java.lang.Exception

loadByName

public com.crm.dataobject.accounts.CRMDOPaymentPreference loadByName(java.lang.String name)
                                                              throws java.lang.Exception

Loads a payment preference by a name.

Parameters:

name - - the name to load by

Returns:

a payment preference with the given name

Throws:

java.lang.Exception

loadByName

public com.crm.dataobject.accounts.CRMDOPaymentPreference loadByName(java.lang.String name,
                                                                     java.util.ArrayList<java.lang.String> associations)
                                                              throws java.lang.Exception

Loads a payment preference by a name.

Parameters:

name - - the name to load by

associations - - a list of associated objects

Returns:

a payment preference with the given name

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting)
                                                   throws java.lang.Exception

Loads a list of payment preferences by a payment gateway setting.

Parameters:

paymentGatewaySetting - - the payment gateway setting to load by

Returns:

a list of payment preferences

Throws:

java.lang.Exception

load

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

Loads a list of payment preferences given the accounts receivable

Parameters:

accountReceivable - - the accounts receivable to load the payment preferences for

Returns:

a list of payment preferences of the given account

Throws:

java.lang.Exception

loadAllowedBankAccountTypes

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

Returns the allowed bank account types.

Returns:

the allowed bank account types

Throws:

java.lang.Exception

loadAllowedBankAccountTypes

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadAllowedBankAccountTypes(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference)
                                                                          throws java.lang.Exception

Returns the allowed bank account types of the given payment preference.

Parameters:

paymentPreference - - the payment preference to load its allowed bank account types

Returns:

the allowed bank account types of the given payment preference

Throws:

java.lang.Exception

loadAllowedBanks

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

Returns the allowed banks

Returns:

the allowed banks

Throws:

java.lang.Exception

loadAllowedBanks

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadAllowedBanks(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference)
                                                               throws java.lang.Exception

Returns the allowed banks of the given payment preference.

Parameters:

paymentPreference - - the payment preference to load its allowed banks

Returns:

the allowed banks of the given payment preference

Throws:

java.lang.Exception

loadAllowedPaymentMediumTypes

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

Returns the allowed payment medium types.

Returns:

the allowed payment medium types

Throws:

java.lang.Exception

loadAllowedPaymentMediumTypes

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadAllowedPaymentMediumTypes(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference)
                                                                            throws java.lang.Exception

Returns the allowed payment medium types of the given payment preference.

Parameters:

paymentPreference - - the payment preference to load the allowed payment medium types for

Returns:

the allowed payment medium types of the given payment preference

Throws:

java.lang.Exception

loadAllowedPaymentMediumBrands

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

Returns the allowed payment medium brands.

Returns:

the allowed payment medium brands

Throws:

java.lang.Exception

loadAllowedPaymentMediumBrands

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadAllowedPaymentMediumBrands(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference)
                                                                             throws java.lang.Exception

Returns the allowed payment medium brands of the given payment preference.

Parameters:

paymentPreference - - the payment preference to load the allowed payment medium brands for

Returns:

the allowed payment medium brands of the given payment preference

Throws:

java.lang.Exception

exists

public java.lang.Boolean exists(java.util.Set<com.crm.dataobject.accounts.CRMDOPaymentPreference> existingPaymentPreferences,
                                com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference)

Checks whether a payment preference exists in the given parameter list having the given parameter name and non-null parameter value

Parameters:

existingPaymentPreferences - - the parameter list to check

paymentPreference - - the payment preference to check with

Returns:

true if exist, false if not