java.lang.Object | +--com.ibm.commerce.beans.InputDataBeanImpl | +--com.ibm.commerce.beans.SmartDataBeanImpl | +--com.ibm.commerce.payment.beans.PaymentPolicyListDataBean
This DataBean, when populated, gives a list of PaymentPolicyInfo beans representing Payment Business Policies that the Store supports.
PaymentPolicyInfo
, Serialized
Form
Field Summary | |
---|---|
static java.lang.String |
CURRENCY_CODE_UNKNOWN The special currency code used if the numeric currency code used by WebSphere Commerce Payments does not have a corresponding alpha code in the SETCURR Table |
protected
java.util.Hashtable |
ihshMerchantAccountInfoByCassette Hashtable for storing the set of MerchantAccountInfo objects for the Store keyed by the cassette name. |
protected
java.util.Hashtable |
ihshNonCassetteBasedPaymentPolicyInfo Hashtable for storing the set of non-cassette based PaymentPolicyInfo objects for the Store. |
protected
java.util.Hashtable |
ihshPaymentPolicyInfoByCassette Hashtable for storing the set of PaymentPolicyInfo objects for the Store keyed by the cassette name. |
protected
java.util.Hashtable |
ihshPaymentPolicyInfoForSupportedCassette Hashtable for storing the set of PaymentPolicyInfo objects for the supported cassette. |
protected
java.util.Vector |
ivecDefinedPaymentPolicies // Vector for storing the name of the defined Payment Policies for the Store |
protected
java.util.Vector |
ivecMerchantAccountInfo Vector for storing the MerchantAccountInfo objects of the Store |
protected
java.util.Vector |
ivecSupportedCassettes Vector for storing the name of the supported Cassettes for the Store |
protected
java.util.Vector |
ivecSupportedPaymentPolicyInfo Vector for storing the supported PaymentPolicyInfo for the Store |
static java.lang.String |
POLICY_NAME_CREDIT_LINE The name of the Credit Line payment business policy |
Fields inherited from class com.ibm.commerce.beans. SmartDataBeanImpl |
commandContext,
COPYRIGHT |
Fields inherited from class com.ibm.commerce.beans. InputDataBeanImpl |
requestProperties |
Fields inherited from interface com.ibm.commerce.beans. DataBean |
emptyString |
Constructor Summary | |
---|---|
PaymentPolicyListDataBean() PaymentPolicyListDataBean default constructor. |
Method Summary | |
---|---|
protected
void |
completeMerchantAccountInfo() Goes through the set of MerchantAccountInfo objects and completes the MerchantAccountInfo properties for each. |
protected
void |
completeSupportedPaymentPolicyInfoForStore() Goes through the Hashtable for PaymentPolicyInfo for Supported Cassettes and completes the PaymentPolicyInfo for each of the Supported Cassettes creating new PaymentPolicInfo object if needed. |
protected
void |
findDefinedPaymentPoliciesForStore() Finds all the defined Payment Policies for the Store. |
protected
void |
findPaymentPoliciesForSupportedCassettes() Find the Payment Policies for each of the Supported Cassettes for the Store. |
protected
void |
findSupportedCassettesAndAccountsForStore() Finds the supported Cassettes and WebSphere Commerce Payments Merchant Accounts for the Store. |
java.lang.String |
getMessage() Returns the message property of the Bean. |
PaymentPolicyInfo[] |
getNonPMPaymentPolicyInfo() Returns an array of PaymentPolicyInfo for the Store representing the set of non-cassette based Payment Policies configured and usable by the Store. |
PaymentPolicyInfo[] |
getPaymentPolicyInfoUsableWithoutTA(java.lang.String astrCurrency) Returns an array of PaymentPolicyInfo representing Payment Policies usable by the specified Store. |
java.lang.Exception |
getPaymentSystemException() Returns any Exception thrown by the Payment System during the population of the List DataBean or null. |
PaymentPolicyInfo[] |
getPMPaymentPolicyInfo() Returns an array of PaymentPolicyInfo for the Store representing the set of cassette-based Payment Policies configured and usable by the Store. |
int |
getPrimaryRC() Returns the primary return code as returned from the WebSphere Commerce Payments QueryAccounts command. |
int |
getSecondaryRC() Returns the secondary return code as returned from the WebSphere Commerce Payments QueryAccounts command. |
protected
java.lang.Integer |
getStoreId() Returns the storeId property of the Bean |
void |
populate() Populate the Bean Properties. |
protected
void |
setLanguageId(java.lang.Integer aLanguageId) Sets the languageId property of the Bean |
protected
void |
setMessage(java.lang.String astrMessage) Sets the message property of the Bean. |
protected
void |
setPaymentSystemException(java.lang.Exception exc) Saves the Exception object returned by the Payment System during the activation of this DataBean. |
void |
setPolicyName(java.lang.String aPolicyName) Optionally specify the name of the payment policy you wish to request for information. |
protected
void |
setPrimaryRC(int anPrimaryRC) Sets the primary return code as returned from the WebSphere Commerce Payments QueryOrders command. |
protected
void |
setSecondaryRC(int anSecondaryRC) Sets the secondary return code as returned from the WebSphere Commerce Payments QueryOrders command. |
void |
setStoreId(java.lang.Integer aStoreId) Sets the Store ID for which the list of usable Payment Policies are requested. |
Methods inherited from class com.ibm.commerce.beans. SmartDataBeanImpl |
fulfills,
getCommandContext,
getResources,
setCommandContext |
Methods inherited from class com.ibm.commerce.beans. InputDataBeanImpl |
getRequestProperties,
setRequestProperties |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Methods inherited from interface com.ibm.commerce.beans. InputDataBean |
getRequestProperties,
setRequestProperties |
Field Detail |
---|
public static final java.lang.String POLICY_NAME_CREDIT_LINE
public static final java.lang.String CURRENCY_CODE_UNKNOWN
protected java.util.Vector ivecSupportedCassettes
protected java.util.Vector ivecDefinedPaymentPolicies
protected java.util.Vector ivecMerchantAccountInfo
protected java.util.Vector ivecSupportedPaymentPolicyInfo
protected java.util.Hashtable ihshMerchantAccountInfoByCassette
protected java.util.Hashtable ihshPaymentPolicyInfoByCassette
protected java.util.Hashtable ihshNonCassetteBasedPaymentPolicyInfo
protected java.util.Hashtable ihshPaymentPolicyInfoForSupportedCassette
Constructor Detail |
---|
public PaymentPolicyListDataBean()
Method Detail |
---|
protected void completeMerchantAccountInfo() throws ECException
ECException
protected void completeSupportedPaymentPolicyInfoForStore() throws ECException
ECException
protected void findDefinedPaymentPoliciesForStore() throws ECException
ECException
protected void findPaymentPoliciesForSupportedCassettes() throws ECException
ECException.
ECException
protected void findSupportedCassettesAndAccountsForStore() throws ECException
ECException
public java.lang.String getMessage()
This is mainly for diagnostics purposes.
public PaymentPolicyInfo[] getNonPMPaymentPolicyInfo()
This method returns a zero-length array if there is no non-cassette based Payment Policy that is usable by the Store.
PaymentPolicyInfo.
public PaymentPolicyInfo[] getPaymentPolicyInfoUsableWithoutTA(java.lang.String astrCurrency)
public java.lang.Exception getPaymentSystemException()
This is useful for diagnostics or for determining whether to display a user-friendly message to the customer when an empty list of PaymentTCInfo bean is returned by the getPaymentTCInfo() method.
One possible Exception returned is the com.ibm.etill.framework.clientapi.PaymentServerCommunicationException which indicates a failure to communicate with WebSphere Commerce Payments.
public PaymentPolicyInfo[] getPMPaymentPolicyInfo()
This method returns a zero-length array if there is no configured Payment Policy usable by the Store or if there is a problem obtaining the infomation from WebSphere Commerce Payments.
PaymentPolicyInfo.
public int getPrimaryRC()
This is mainly for diagnostics purposes.
public int getSecondaryRC()
This is mainly for diagnostics purposes.
protected java.lang.Integer getStoreId()
public void populate() throws java.lang.Exception
populate
in interface
SmartDataBean
populate
in class
SmartDataBeanImpl
Exception.
java.lang.Exception
- should not happen since there is no data
retrieved to populate the databean.protected void setLanguageId(java.lang.Integer aLanguageId)
aLanguageId
- the internal ID of the preferred language of the
requester.protected void setMessage(java.lang.String astrMessage)
astrMessage
- the String messageprotected void setPaymentSystemException(java.lang.Exception exc)
exc
- the Exception object returned by the Payment
Systempublic void setPolicyName(java.lang.String aPolicyName)
protected void setPrimaryRC(int anPrimaryRC)
anPrimaryRC
- the primary return code as returned from the
WebSphere Commerce Payments QueryOrders command.protected void setSecondaryRC(int anSecondaryRC)
anSecondaryRC
- the secondary return code as returned from the
WebSphere Commerce Payments QueryOrders command.public void setStoreId(java.lang.Integer aStoreId)
aStoreId
- the Store ID.