com.crm.businessobject.paymentgateway

Class CRMBOPaymentGatewaySettingBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.paymentgateway.CRMBOPaymentGatewaySettingBean

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CRMBOBraintreePaymentGatewaySettingBean, CRMBOGenericPaymentGatewaySettingBean, CRMBOPaypalPaymentGatewaySettingBean, CRMBOStripePaymentGatewaySettingBean

public class CRMBOPaymentGatewaySettingBean
extends CRMBO

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOPaymentGatewaySettingBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	canUseForRecurringPayments(com.crm.dataobject.accounts.CRMDOAccountPaymentPreference accountPaymentPreference)
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a payment gateway setting.
com.crm.process.paymentgateway.PaymentGatewayInterface	getGatewayService(com.crm.dataobject.paymentgateway.PaymentGatewayProtocol protocol)
com.crm.framework.metadata.PaymentGateway	getPaymentGateway(com.crm.dataobject.accounts.CRMDOAccountPaymentPreference accountPaymentPreference)
com.crm.framework.metadata.PaymentGateway	getPaymentGateway(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference)
java.util.ArrayList<com.crm.framework.metadata.PaymentGateway>	getPaymentGateways(com.crm.framework.metadata.Paymentmethod paymentmethod)
com.crm.dataobject.accounts.PaymentPreferenceType	getPaymentPreferenceType(com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting)
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	initializeParameters(com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting) Initialize the values of a payment gateway setting from an XML file.
java.lang.Boolean	isCurrencySupported(com.crm.dataobject.platform.CRMDOCurrency currency, com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting)
java.lang.Boolean	isValid(com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType financialTransactionType)
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	load(com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod, java.lang.Boolean applicationServerFiltering) Loads a payment gateway setting based on the given criteria
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	load(com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod, com.crm.dataobject.paymentgateway.PaymentGatewayProtocol paymentGatewayProtocol, java.lang.Boolean applicationServerFiltering) Deprecated.
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	load(com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod, java.lang.String paymentGatewayProtocol, java.lang.Boolean applicationServerFiltering) Loads a payment gateway setting based on the given criteria
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	load(com.crm.dataobject.paymentgateway.PaymentGatewayProtocol paymentGatewayProtocol) Loads the payment gateway setting of a payment gateway.
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	loadByAltCode(java.lang.String altCode) Loads a payment gateway setting by an alternative code.
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	loadByAltCode(java.lang.String altCode, java.util.ArrayList<java.lang.String> associations) Loads a payment gateway setting by an alternative code.
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	loadByName(java.lang.String name) Loads a payment gateway setting by a name.
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	loadByName(java.lang.String name, java.util.ArrayList<java.lang.String> associations) Loads a payment gateway setting by a name.
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	loadByProtocol(java.lang.String protocol) Loads a payment gateway setting by an alternative code.
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	loadByProtocol(java.lang.String protocol, java.util.ArrayList<java.lang.String> associations) Loads a payment gateway setting by an alternative code.
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	loadEffective(com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType financialTransactionType)
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	loadEffective(com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod, java.lang.Boolean applicationServerFiltering) Loads an effective payment gateway setting based on the given criteria
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	loadEffective(com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod, com.crm.dataobject.paymentgateway.PaymentGatewayProtocol paymentGatewayProtocol, java.lang.Boolean applicationServerFiltering) Deprecated.
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	loadEffective(com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod, java.lang.String paymentGatewayProtocol, java.lang.Boolean applicationServerFiltering) Loads an effective payment gateway setting based on the given criteria
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	loadEffective(com.crm.dataobject.paymentgateway.PaymentGatewayProtocol paymentGatewayProtocol) Deprecated.
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	loadEffective(com.crm.dataobject.paymentgateway.PaymentGatewayProtocol paymentGatewayProtocol, java.lang.Boolean applicationServerFiltering) Deprecated.
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	loadEffective(java.lang.String paymentGatewayProtocol) Loads the effective and allowed by the current application server payment gateway setting of a payment gateway.
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	loadEffective(java.lang.String paymentGatewayProtocol, java.lang.Boolean applicationServerFiltering) Loads an effective payment gateway setting based on the given criteria
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadGeneric()
java.util.HashMap<java.lang.String,java.lang.Object>	loadPaymentGatewayGeneralParameters(com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting) Loads the general payment gateway parameters
com.crm.dataobject.CRMDO	save(com.crm.dataobject.CRMDO dto) Saves a payment gateway setting.
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	setObjectsFromXML(com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting) Sets the values of a payment gateway setting from an XML file.
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	setXMLFromObjects(com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting) Constructs an XML file from a payment gateway setting.

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

CRMBOPaymentGatewaySettingBean

public CRMBOPaymentGatewaySettingBean()

Default constructor.

Method Detail

setXMLFromObjects

public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting setXMLFromObjects(com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting)
                                                                               throws java.lang.Exception

Constructs an XML file from a payment gateway setting.

Parameters:

paymentGatewaySetting - - the payment gateway setting to get the values from

Returns:

the payment gateway setting

Throws:

java.lang.Exception

setObjectsFromXML

public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting setObjectsFromXML(com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting)
                                                                               throws java.lang.Exception

Sets the values of a payment gateway setting from an XML file.

Parameters:

paymentGatewaySetting - - the payment gateway setting to set the values for

Returns:

the updated payment gateway setting

Throws:

java.lang.Exception

initializeParameters

public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting initializeParameters(com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting)
                                                                                  throws java.lang.Exception

Initialize the values of a payment gateway setting from an XML file.

Parameters:

paymentGatewaySetting - - the payment gateway setting to set the values for

Returns:

the updated payment gateway setting

Throws:

java.lang.Exception

save

public com.crm.dataobject.CRMDO save(com.crm.dataobject.CRMDO dto)
                              throws java.lang.Exception

Saves a payment gateway setting.

Overrides:

save in class CRMBO

Parameters:

dto - - the payment gateway setting to save

Returns:

the saved payment gateway setting

Throws:

java.lang.Exception

getDefaultAssociations

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

Returns the default associated data objects of a payment gateway setting.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the payment gateway setting

loadByName

public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting loadByName(java.lang.String name)
                                                                        throws java.lang.Exception

Loads a payment gateway setting by a name.

Parameters:

name - - the name of a payment gateway setting

Returns:

a payment gateway setting with the given name

Throws:

java.lang.Exception

loadByName

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

Loads a payment gateway setting by a name.

Parameters:

name - - the name of a payment gateway setting

associations - - a list of associated data objects

Returns:

a payment gateway setting with the given name

Throws:

java.lang.Exception

loadByAltCode

public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting loadByAltCode(java.lang.String altCode)
                                                                           throws java.lang.Exception

Loads a payment gateway setting by an alternative code.

Parameters:

altCode - - the alternative code of a payment gateway setting

Returns:

a payment gateway setting with the given alternative code

Throws:

java.lang.Exception

loadByAltCode

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

Loads a payment gateway setting by an alternative code.

Parameters:

altCode - - the alternative code of a payment gateway setting

associations - - a list of associated data objects

Returns:

a payment gateway setting with the given alternative code

Throws:

java.lang.Exception

loadByProtocol

public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting loadByProtocol(java.lang.String protocol)
                                                                            throws java.lang.Exception

Loads a payment gateway setting by an alternative code.

Parameters:

protocol - - the protocol of a payment gateway setting

Returns:

a payment gateway setting with the given protocol

Throws:

java.lang.Exception

loadByProtocol

public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting loadByProtocol(java.lang.String protocol,
                                                                                   java.util.ArrayList<java.lang.String> associations)
                                                                            throws java.lang.Exception

Loads a payment gateway setting by an alternative code.

Parameters:

protocol - - the protocol of a payment gateway setting

associations - - a list of associated data objects

Returns:

a payment gateway setting with the given protocol

Throws:

java.lang.Exception

load

public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting load(com.crm.dataobject.paymentgateway.PaymentGatewayProtocol paymentGatewayProtocol)
                                                                  throws java.lang.Exception

Loads the payment gateway setting of a payment gateway.

Parameters:

paymentGatewayProtocol - - the payment gateway protocol of a payment gateway setting

Returns:

the active payment gateway setting of the given payment gateway protocol

Throws:

java.lang.Exception

loadEffective

@Deprecated
public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting loadEffective(com.crm.dataobject.paymentgateway.PaymentGatewayProtocol paymentGatewayProtocol)
                                                                                       throws java.lang.Exception

Deprecated.

Loads the effective and allowed by the current application server payment gateway setting of a payment gateway.

Parameters:

paymentGatewayProtocol - - the payment gateway protocol of a payment gateway setting

Returns:

the effective payment gateway setting of the given payment gateway protocol

Throws:

java.lang.Exception

loadEffective

public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting loadEffective(java.lang.String paymentGatewayProtocol)
                                                                           throws java.lang.Exception

Loads the effective and allowed by the current application server payment gateway setting of a payment gateway.

Parameters:

paymentGatewayProtocol - - the payment gateway protocol of a payment gateway setting

Returns:

the effective payment gateway setting of the given payment gateway protocol

Throws:

java.lang.Exception

loadEffective

@Deprecated
public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting loadEffective(com.crm.dataobject.paymentgateway.PaymentGatewayProtocol paymentGatewayProtocol,
                                                                                              java.lang.Boolean applicationServerFiltering)
                                                                                       throws java.lang.Exception

Deprecated.

Loads an effective payment gateway setting based on the given criteria

Parameters:

paymentGatewayProtocol - - the payment gateway protocol of a payment gateway setting

applicationServerFiltering - - if true then application server filtering will be applied

Returns:

the effective payment gateway setting of the given payment gateway protocol

Throws:

java.lang.Exception

loadEffective

public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting loadEffective(java.lang.String paymentGatewayProtocol,
                                                                                  java.lang.Boolean applicationServerFiltering)
                                                                           throws java.lang.Exception

Loads an effective payment gateway setting based on the given criteria

Parameters:

paymentGatewayProtocol - - the payment gateway protocol of a payment gateway setting

applicationServerFiltering - - if true then application server filtering will be applied

Returns:

the effective payment gateway setting of the given payment gateway protocol

Throws:

java.lang.Exception

loadEffective

public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting loadEffective(com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod,
                                                                                  java.lang.Boolean applicationServerFiltering)
                                                                           throws java.lang.Exception

Loads an effective payment gateway setting based on the given criteria

Parameters:

paymentMethod - - the payment method to load the payment gateway setting for

applicationServerFiltering - - if true then application server filtering will be applied

Returns:

an effective payment gateway setting

Throws:

java.lang.Exception

loadEffective

@Deprecated
public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting loadEffective(com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod,
                                                                                              com.crm.dataobject.paymentgateway.PaymentGatewayProtocol paymentGatewayProtocol,
                                                                                              java.lang.Boolean applicationServerFiltering)
                                                                                       throws java.lang.Exception

Deprecated.

Loads an effective payment gateway setting based on the given criteria

Parameters:

paymentMethod - - the payment method to load the payment gateway setting for

paymentGatewayProtocol - - the payment gateway protocol of a payment gateway setting

applicationServerFiltering - - if true then application server filtering will be applied

Returns:

an effective payment gateway setting

Throws:

java.lang.Exception

loadGeneric

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

Throws:

java.lang.Exception

loadEffective

public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting loadEffective(com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod,
                                                                                  java.lang.String paymentGatewayProtocol,
                                                                                  java.lang.Boolean applicationServerFiltering)
                                                                           throws java.lang.Exception

Loads an effective payment gateway setting based on the given criteria

Parameters:

paymentMethod - - the payment method to load the payment gateway setting for

paymentGatewayProtocol - - the payment gateway protocol of a payment gateway setting

applicationServerFiltering - - if true then application server filtering will be applied

Returns:

an effective payment gateway setting

Throws:

java.lang.Exception

load

public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting load(com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod,
                                                                         java.lang.Boolean applicationServerFiltering)
                                                                  throws java.lang.Exception

Loads a payment gateway setting based on the given criteria

Parameters:

paymentMethod - - the payment method to load the payment gateway setting for

applicationServerFiltering - - if true then application server filtering will be applied

Returns:

a payment gateway setting

Throws:

java.lang.Exception

load

@Deprecated
public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting load(com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod,
                                                                                     com.crm.dataobject.paymentgateway.PaymentGatewayProtocol paymentGatewayProtocol,
                                                                                     java.lang.Boolean applicationServerFiltering)
                                                                              throws java.lang.Exception

Deprecated.

Loads a payment gateway setting based on the given criteria

Parameters:

paymentMethod - - the payment method to load the payment gateway setting for

paymentGatewayProtocol - - the payment gateway protocol of a payment gateway setting

applicationServerFiltering - - if true then application server filtering will be applied

Returns:

a payment gateway setting

Throws:

java.lang.Exception

load

public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting load(com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod,
                                                                         java.lang.String paymentGatewayProtocol,
                                                                         java.lang.Boolean applicationServerFiltering)
                                                                  throws java.lang.Exception

Loads a payment gateway setting based on the given criteria

Parameters:

paymentMethod - - the payment method to load the payment gateway setting for

paymentGatewayProtocol - - the payment gateway protocol of a payment gateway setting

applicationServerFiltering - - if true then application server filtering will be applied

Returns:

a payment gateway setting

Throws:

java.lang.Exception

loadEffective

public com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting loadEffective(com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType financialTransactionType)
                                                                           throws java.lang.Exception

Throws:

java.lang.Exception

isValid

public java.lang.Boolean isValid(com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting,
                                 com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType financialTransactionType)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getGatewayService

public com.crm.process.paymentgateway.PaymentGatewayInterface getGatewayService(com.crm.dataobject.paymentgateway.PaymentGatewayProtocol protocol)
                                                                         throws java.lang.Exception

Throws:

java.lang.Exception

loadPaymentGatewayGeneralParameters

public java.util.HashMap<java.lang.String,java.lang.Object> loadPaymentGatewayGeneralParameters(com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting)
                                                                                         throws java.lang.Exception

Loads the general payment gateway parameters

Parameters:

paymentGatewaySetting - - the payment gateway to load its parameters

Throws:

java.lang.Exception

isCurrencySupported

public java.lang.Boolean isCurrencySupported(com.crm.dataobject.platform.CRMDOCurrency currency,
                                             com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getPaymentGateway

public com.crm.framework.metadata.PaymentGateway getPaymentGateway(com.crm.dataobject.accounts.CRMDOAccountPaymentPreference accountPaymentPreference)
                                                            throws java.lang.Exception

Throws:

java.lang.Exception

getPaymentGateway

public com.crm.framework.metadata.PaymentGateway getPaymentGateway(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference)
                                                            throws java.lang.Exception

Throws:

java.lang.Exception

getPaymentGateways

public java.util.ArrayList<com.crm.framework.metadata.PaymentGateway> getPaymentGateways(com.crm.framework.metadata.Paymentmethod paymentmethod)
                                                                                  throws java.lang.Exception

Throws:

java.lang.Exception

getPaymentPreferenceType

public com.crm.dataobject.accounts.PaymentPreferenceType getPaymentPreferenceType(com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting)

canUseForRecurringPayments

public boolean canUseForRecurringPayments(com.crm.dataobject.accounts.CRMDOAccountPaymentPreference accountPaymentPreference)
                                   throws java.lang.Exception

Throws:

java.lang.Exception