com.ibm.commerce.payment.beans
Class PaymentPolicyListDataBean

com.ibm.commerce.payment.beans.PaymentPolicyListDataBean

public class PaymentPolicyListDataBean

This DataBean, when populated, gives a list of PaymentPolicyInfo beans representing Payment Policies that the Store supports.

See Also:
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

CURRENCY_CODE_UNKNOWN

public static final java.lang.String CURRENCY_CODE_UNKNOWN

ihshMerchantAccountInfoByCassette

protected java.util.Hashtable ihshMerchantAccountInfoByCassette

ihshNonCassetteBasedPaymentPolicyInfo

protected java.util.Hashtable ihshNonCassetteBasedPaymentPolicyInfo

ihshPaymentPolicyInfoByCassette

protected java.util.Hashtable ihshPaymentPolicyInfoByCassette

ihshPaymentPolicyInfoForSupportedCassette

protected java.util.Hashtable ihshPaymentPolicyInfoForSupportedCassette

ivecDefinedPaymentPolicies

protected java.util.Vector ivecDefinedPaymentPolicies

ivecMerchantAccountInfo

protected java.util.Vector ivecMerchantAccountInfo

ivecSupportedCassettes

protected java.util.Vector ivecSupportedCassettes

ivecSupportedPaymentPolicyInfo

protected java.util.Vector ivecSupportedPaymentPolicyInfo

POLICY_NAME_CREDIT_LINE

public static final java.lang.String POLICY_NAME_CREDIT_LINE
Constructor Detail

PaymentPolicyListDataBean

public PaymentPolicyListDataBean()
PaymentPolicyListDataBean default constructor.
Method Detail

completeMerchantAccountInfo

protected void completeMerchantAccountInfo()
                                    throws ECException
Goes through the set of MerchantAccountInfo objects and completes the MerchantAccountInfo Properties for each.

completeSupportedPaymentPolicyInfoForStore

protected void completeSupportedPaymentPolicyInfoForStore()
                                                   throws ECException
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.

findDefinedPaymentPoliciesForStore

protected void findDefinedPaymentPoliciesForStore()
                                           throws ECException
Finds all the defined Payment Policies for the Store.

findPaymentPoliciesForSupportedCassettes

protected void findPaymentPoliciesForSupportedCassettes()
                                                 throws ECException
Find the Payment Policies for each of the Supported Cassettes for the Store. This will be a subset of the set of defined policies for the Store.
Throws:
ECException. -  

findSupportedCassettesAndAccountsForStore

protected void findSupportedCassettesAndAccountsForStore()
                                                  throws ECException
Finds the supported Cassettes and Payment Manager Merchant Accounts for the Store.

getMessage

public java.lang.String getMessage()
Returns the message property of the Bean. The message property stores any message received during population of the Bean. It may be the empty String if no message has been received.

This is mainly for diagnostics purposes.

Returns:
any String message received during population of the DataBean or the empty String if no message has been received.

getNonPMPaymentPolicyInfo

public PaymentPolicyInfo[] getNonPMPaymentPolicyInfo()
Returns an array of PaymentPolicyInfo for the Store representing non-PaymentManager based Payment Policies configured and usable by the Store.

This method returns a zero-length array if there is non-PaymentMnager based configured Payment Policy usable by the Store.

Returns:
com.ibm.commerce.payment.beans.PaymentPolicyInfo[] an array of PaymentPolicyInfo.
See Also:
PaymentPolicyInfo.

getPaymentPolicyInfoUsableWithoutTA

public PaymentPolicyInfo[] getPaymentPolicyInfoUsableWithoutTA(java.lang.String astrCurrency)
Returns an array of PaymentPolicyInfo representing Payment Policies usable by the specified Store. The specified currency is intended to filter out Payment Policies that are known to not support certain currency. It is NOT a guarantee that Payment Policies returned will definitely support the specified currency.
Parameters:
currency - the String representing the currency that the Payment Policy needs to support.
Returns:
an array of PaymentPolicyInfo bean.

getPaymentSystemException

public java.lang.Exception getPaymentSystemException()
Returns a null or any Exception thrown by the Payment System client during the population of the List DataBean.

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.

Returns:
the java.lang.Exception object thrown by the Payment System client or null if none was thrown.

getPMPaymentPolicyInfo

public PaymentPolicyInfo[] getPMPaymentPolicyInfo()
Returns an array of PaymentPolicyInfo for the Store representing Payment Manager based Payment Policies configured and usable by the Store.

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.

Returns:
com.ibm.commerce.payment.beans.PaymentPolicyInfo[] an array of PaymentPolicyInfo.
See Also:
PaymentPolicyInfo.

getPrimaryRC

public int getPrimaryRC()
Returns the primary return code as returned from the Payment Manager QueryAccounts command.

This is mainly for diagnostics purposes.

Returns:
the primary return code from the Payment Manager QueryAccounts command or -1 if an error occurred before the QueryAccounts command was issued.

getSecondaryRC

public int getSecondaryRC()
Returns the secondary return code as returned from the Payment Manager QueryAccounts command.

This is mainly for diagnostics purposes.

Returns:
the secondary return code from the Payment Manager QueryAccounts command or -1 if an error occurred before the QueryAccounts command was issued.

getStoreId

protected java.lang.Integer getStoreId()
Returns the storeId property of the Bean
Returns:
the Integer representing the Reference Number of the Store to which the order belongs.

populate

public void populate()
              throws java.lang.Exception
Populate the Bean Properties. This method is called by the DataBeanManager during DataBean activation.
Throws:
Exception. -  

setLanguageId

protected void setLanguageId(java.lang.Integer aLanguageId)
Sets the languageId property of the Bean
Parameters:
aLanguageId - the Integer representing the Reference Number of the preferred Language of the requester.

setMessage

protected void setMessage(java.lang.String astrMessage)
Sets the message property of the Bean. The message property stores any message received during population of the Bean. It may be null.
Parameters:
astrMessage - the String used to set the message property of the Bean.

setPaymentSystemException

protected void setPaymentSystemException(java.lang.Exception exc)
Saves the Exception object returned by the Payment System client during the activation of this DataBean. The Payment System is the WebSphere Payment Manager in this case.
Parameters:
exc - the Exception object returned by the Payment System client.

setPolicyName

public void setPolicyName(java.lang.String aPolicyName)
Optionally specify the name of the payment policy you wish to request for information. If no name is specified, information on all payment policies for which the Store is configured will be retrieved.
Parameters:
policyName - java.lang.String name of the payment policy.

setPrimaryRC

protected void setPrimaryRC(int anPrimaryRC)
Sets the primary return code as returned from the Payment Manager QueryOrders command.
Parameters:
anPrimaryRC - the primary return code as returned from the Payment Manager QueryOrders command.

setSecondaryRC

protected void setSecondaryRC(int anSecondaryRC)
Sets the secondary return code as returned from the Payment Manager QueryOrders command.
Parameters:
anSecondaryRC - the secondary return code as returned from the Payment Manager QueryOrders command.

setStoreId

public void setStoreId(java.lang.Integer aStoreId)
Set the store Id for retrieving those PaymentPolicies.
Parameters:
aStoreId - the order Id.