public class PaymentPolicyListDataBean extends SmartDataBeanImpl implements com.ibm.commerce.payment.beans.PaymentPolicyListInputDataBean, com.ibm.commerce.payment.beans.PaymentPolicyListSmartDataBean
PaymentPolicyInfo
,
Serialized FormModifier and Type | Field and Description |
---|---|
static java.lang.String |
CURRENCY_CODE_UNKNOWN
The special currency code used if the numeric currency code
does not have a corresponding alpha code in the SETCURR Table.
|
static java.lang.String |
POLICY_NAME_CREDIT_LINE
The name of the Credit Line payment business policy in WebSphere Commerce v5.x
|
static java.lang.String |
POLICY_NAME_LINEOFCREDIT
The name of the Credit Line payment business policy
|
static java.lang.String |
POLICY_NAME_VOID_CHECKOUT
The name of the Void Checkout payment business policy
|
emptyString
Constructor and Description |
---|
PaymentPolicyListDataBean()
PaymentPolicyListDataBean default constructor.
|
Modifier and Type | Method and Description |
---|---|
PaymentPolicyInfo[] |
getAllNonPMPaymentPolicyInfo()
Returns an array of PaymentPolicyInfo for the Store representing
the set of non-cassette based Payment Policies configured and usable
by 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()
Returns an array of PaymentPolicyInfo representing Payment Policies usable by the specified 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.
|
static boolean |
isCreditPaymentPolicy(java.lang.String policyName)
Returns if the policy name is a Credit Line policy
|
void |
populate()
Populate the Bean Properties.
|
void |
setFindCreditLinePolicy(boolean b)
Sets if we should only return the credit line business policy
|
void |
setPolicyName(java.lang.String aPolicyName)
Optionally specify the name of the payment policy you wish to request for information.
|
void |
setStoreId(java.lang.Integer aStoreId)
Sets the Store ID for which the list of usable Payment Policies are requested.
|
fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext
getRequestProperties, setRequestProperties
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getCommandContext, setCommandContext
getRequestProperties, setRequestProperties
public static final java.lang.String POLICY_NAME_CREDIT_LINE
public static final java.lang.String POLICY_NAME_LINEOFCREDIT
public static final java.lang.String POLICY_NAME_VOID_CHECKOUT
public static final java.lang.String CURRENCY_CODE_UNKNOWN
public PaymentPolicyListDataBean()
public java.lang.String getMessage()
This is mainly for diagnostics purposes.
getMessage
in interface com.ibm.commerce.payment.beans.PaymentPolicyListSmartDataBean
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.
getNonPMPaymentPolicyInfo
in interface com.ibm.commerce.payment.beans.PaymentPolicyListSmartDataBean
PaymentPolicyInfo
public PaymentPolicyInfo[] getAllNonPMPaymentPolicyInfo()
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)
getPaymentPolicyInfoUsableWithoutTA
in interface com.ibm.commerce.payment.beans.PaymentPolicyListSmartDataBean
astrCurrency
- the String representing the currency that the Payment Policy needs to support.public java.lang.Exception getPaymentSystemException()
When an empty list of PaymentTCInfo bean is returned by the getPaymentTCInfo() method. This is useful for diagnostics or for determining whether to display a user-friendly message to the customer.
One possible Exception returned is the com.ibm.etill.framework.clientapi.PaymentServerCommunicationException which indicates a failure to communicate with WebSphere Commerce Payments.
getPaymentSystemException
in interface com.ibm.commerce.payment.beans.PaymentPolicyListSmartDataBean
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 information from WebSphere Commerce Payments.
getPMPaymentPolicyInfo
in interface com.ibm.commerce.payment.beans.PaymentPolicyListSmartDataBean
PaymentPolicyInfo
public int getPrimaryRC()
This is mainly for diagnostics purposes.
getPrimaryRC
in interface com.ibm.commerce.payment.beans.PaymentPolicyListSmartDataBean
public int getSecondaryRC()
This is mainly for diagnostics purposes.
getSecondaryRC
in interface com.ibm.commerce.payment.beans.PaymentPolicyListSmartDataBean
public void populate() throws java.lang.Exception
populate
in interface SmartDataBean
populate
in class SmartDataBeanImpl
Exception.
java.lang.Exception
- This method should never be thrown because there is no data retrieved to populate the data bean.public void setPolicyName(java.lang.String aPolicyName)
setPolicyName
in interface com.ibm.commerce.payment.beans.PaymentPolicyListInputDataBean
aPolicyName
- the name of the payment policy.public void setStoreId(java.lang.Integer aStoreId)
setStoreId
in interface com.ibm.commerce.payment.beans.PaymentPolicyListInputDataBean
aStoreId
- the Store ID.public PaymentPolicyInfo[] getPaymentPolicyInfoUsableWithoutTA()
public void setFindCreditLinePolicy(boolean b)
b
- public static boolean isCreditPaymentPolicy(java.lang.String policyName)
policyName
- the name of the payment business policy