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:

CRMBOStripePaymentGatewaySettingBean, CRMBOWorldPayPaymentGatewaySettingBean

public abstract class CRMBOPaymentGatewaySettingBean
extends CRMBO

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOPaymentGatewaySettingBean() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a payment gateway setting.
abstract 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	isValid(com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType financialTransactionType)
java.lang.Boolean	isValid(com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting, com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod)
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	loadEffective(com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType financialTransactionType)
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	loadEffective(com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod)
com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting	loadEffective(com.crm.dataobject.paymentgateway.PaymentGatewayProtocol paymentGatewayProtocol) Loads the effective payment gateway setting of a payment gateway.
com.crm.dataobject.CRMDO	save(com.crm.dataobject.CRMDO dto) Saves a payment gateway setting.

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, load, load, load, load, load, load, load, load, loadAll, loadAll, loadAll, parseAssociations, save, save, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, validateOnDelete, validateOnDelete, validateOnDelete, validateOnSave, validateOnSave, validateOnSave

Methods inherited from class com.crm.businessobject.CRMBase

dispatch, getCRMSession, getCRMSessionHandle, 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

initializeParameters

public abstract 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

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

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

Loads the effective 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(com.crm.dataobject.financialtransactions.CRMDOPaymentMethod paymentMethod)
                                                                           throws java.lang.Exception

Throws:

java.lang.Exception

isValid

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

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