|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.ibm.commerce.payment.beans.PaymentPolicyListDataBean
This DataBean, when populated, gives a list of PaymentPolicyInfo beans representing Payment Policies that the Store supports.
PaymentPolicyInfo
Field Summary | |
static java.lang.String |
CURRENCY_CODE_UNKNOWN
|
protected java.util.Hashtable |
ihshMerchantAccountInfoByCassette
|
protected java.util.Hashtable |
ihshNonCassetteBasedPaymentPolicyInfo
|
protected java.util.Hashtable |
ihshPaymentPolicyInfoByCassette
|
protected java.util.Hashtable |
ihshPaymentPolicyInfoForSupportedCassette
|
protected java.util.Vector |
ivecDefinedPaymentPolicies
|
protected java.util.Vector |
ivecMerchantAccountInfo
|
protected java.util.Vector |
ivecSupportedCassettes
|
protected java.util.Vector |
ivecSupportedPaymentPolicyInfo
|
static java.lang.String |
POLICY_NAME_CREDIT_LINE
|
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 Payment Manager 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 non-PaymentManager 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 a null or any Exception thrown by the Payment System client during the population of the List DataBean. |
PaymentPolicyInfo[] |
getPMPaymentPolicyInfo()
Returns an array of PaymentPolicyInfo for the Store representing Payment Manager based Payment Policies configured and usable by the Store. |
int |
getPrimaryRC()
Returns the primary return code as returned from the Payment Manager QueryAccounts command. |
int |
getSecondaryRC()
Returns the secondary return code as returned from the Payment Manager 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 client 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 Payment Manager QueryOrders command. |
protected void |
setSecondaryRC(int anSecondaryRC)
Sets the secondary return code as returned from the Payment Manager QueryOrders command. |
void |
setStoreId(java.lang.Integer aStoreId)
Set the store Id for retrieving those PaymentPolicies. |
Field Detail |
public static final java.lang.String CURRENCY_CODE_UNKNOWN
protected java.util.Hashtable ihshMerchantAccountInfoByCassette
protected java.util.Hashtable ihshNonCassetteBasedPaymentPolicyInfo
protected java.util.Hashtable ihshPaymentPolicyInfoByCassette
protected java.util.Hashtable ihshPaymentPolicyInfoForSupportedCassette
protected java.util.Vector ivecDefinedPaymentPolicies
protected java.util.Vector ivecMerchantAccountInfo
protected java.util.Vector ivecSupportedCassettes
protected java.util.Vector ivecSupportedPaymentPolicyInfo
public static final java.lang.String POLICY_NAME_CREDIT_LINE
Constructor Detail |
public PaymentPolicyListDataBean()
Method Detail |
protected void completeMerchantAccountInfo() throws ECException
protected void completeSupportedPaymentPolicyInfoForStore() throws ECException
protected void findDefinedPaymentPoliciesForStore() throws ECException
protected void findPaymentPoliciesForSupportedCassettes() throws ECException
ECException.
- protected void findSupportedCassettesAndAccountsForStore() throws 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 non-PaymentMnager based configured Payment Policy usable by the Store.
PaymentPolicyInfo.
public PaymentPolicyInfo[] getPaymentPolicyInfoUsableWithoutTA(java.lang.String astrCurrency)
currency
- the String representing the currency that the Payment Policy needs to support.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 the Payment Manager.
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 the Payment Manager.
PaymentPolicyInfo.
public int getPrimaryRC()
This is mainly for diagnostics purposes.
public int getSecondaryRC()
This is mainly for diagnostics purposes.
protected java.lang.Integer getStoreId()
Integer
representing the Reference Number
of the Store to which the order belongs.public void populate() throws java.lang.Exception
Exception.
- protected void setLanguageId(java.lang.Integer aLanguageId)
aLanguageId
- the Integer
representing the Reference Number
of the preferred Language of the requester.protected void setMessage(java.lang.String astrMessage)
astrMessage
- the String
used to set the message property
of the Bean.protected void setPaymentSystemException(java.lang.Exception exc)
exc
- the Exception object returned by the Payment System client.public void setPolicyName(java.lang.String aPolicyName)
policyName
- java.lang.String name of the payment policy.protected void setPrimaryRC(int anPrimaryRC)
anPrimaryRC
- the primary return code as returned from the Payment Manager QueryOrders
command.protected void setSecondaryRC(int anSecondaryRC)
anSecondaryRC
- the secondary return code as returned from the Payment Manager
QueryOrders command.public void setStoreId(java.lang.Integer aStoreId)
aStoreId
- the order Id.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |