java.lang.Object | +--com.ibm.commerce.payment.beans.PaymentPolicyInfo
The PaymentPolicyInfo class is a data holder that is used by the PaymentPolicyListDataBean to hold information about the Payment Policy that the Store could use.
Field Summary | |
---|---|
static java.lang.String |
POLICY_PROP_ATTR_PAGE_NAME String constant for the policy property name "attrPageName". |
static java.lang.String |
POLICY_PROP_CASSETTE_NAME String constant for the policy property name "cassetteName". |
static java.lang.String |
POLICY_PROP_CURRENCY_ALLOWED String constant for the policy property name "currencyAllowed". |
static java.lang.String |
POLICY_PROP_OFFLINE_METHOD String constant for the policy property name "offlineMethod". |
static java.lang.String |
POLICY_PROP_PROFILE_NAME String constant for the policy property name "profileName". |
static java.lang.String |
POLICY_PROP_USE_WALLET String constant for the policy property name "useWallet". |
Constructor Summary | |
---|---|
PaymentPolicyInfo(
PaymentPolicyInfo info) PaymentPolicyInfo constructor. | |
PaymentPolicyInfo(java.lang.String astrPolicyId,
java.lang.String astrPolicyName,
java.lang.String astrStoreEntityId) PaymentPolicyInfo constructor. |
Method Summary | |
---|---|
static
PaymentPolicyInfo |
createFromAccessBean(
BusinessPolicyAccessBean abPolicy,
CommandContext cmdCtx) Creates a new instance of a PaymentPolicyInfo Bean from the specified BusinessPolicyAccessBean. |
java.lang.String |
getAttrPageName() Returns the attrPageName property of the payment policy. |
java.lang.String |
getBrand() Returns the brand property of the PaymentPolicyInfo object. |
java.lang.String |
getCashierProfile() Returns the profileName Property of the payment policy. |
java.lang.String |
getCassetteName() Returns the cassetteName Property of the payment policy. |
java.lang.String |
getLongDescription() Returns the long description of the payment policy appended with the brand property if the brand property is a non-empty String. |
java.lang.String |
getOfflineMethod() Returns the offlineMethod property of the payment policy. |
TypedProperty |
getPaymentAttributes() Returns the TypedProperty object containing payment attributes saved. |
java.lang.String |
getPolicyId() Returns the ID of the the payment policy in String form. |
java.lang.String |
getPolicyName() Returns the policyName of the payment policy. |
java.lang.String |
getPolicyType() Returns the policyType of the payment policy. |
java.lang.String |
getShortDescription() Returns the short description of the payment policy appended with the brand property if the brand property is a non-empty String. |
java.lang.String |
getStoreEntityId() Returns the Store Entity ID that this payment policy is defined for. |
java.util.Vector |
getSupportedCurrencies() Returns a Vector of currencies supported by this payment policy if known. |
boolean |
isNotForDefaultTC() Indicates whether or not this payment policy is intended for default PaymentTC. |
protected
PaymentPolicyInfo |
newCopy() Creates a new copy of the PaymentPolicyInfo object from this object. |
boolean |
requiresExplicitTC() Indicates whether or not this payment policy requires an explicit PaymentTC to be used. |
protected
void |
setAccountNumber(java.lang.String astrNumber) Sets the accountNumber property of the bean. |
protected
void |
setAccountTitle(java.lang.String astrTitle) Sets the accountTitle property of the bean. |
protected
void |
setAttrPageName(java.lang.String pageName) Sets the attrPageName property of the bean. |
protected
void |
setBrand(java.lang.String astrBrand) Sets the brand property of the PaymentPolicyInfo object. |
protected
void |
setCashierProfile(java.lang.String astrProfileName) Sets the profileName property of the bean. |
protected
void |
setCassetteName(java.lang.String astrCassetteName) Sets the cassetteName property of the bean. |
protected
void |
setFieldsFromPolicyAB(
BusinessPolicyAccessBean abPolicy,
java.lang.Integer nLanguageId) Sets the other fields of the bean from the BusinessPolicyAccessBean that represents the Payment Policy object. |
protected
void |
setLongDescription(java.lang.String description) Sets the longDescription property of the Bean. |
protected
void |
setOfflineMethod(java.lang.String offlineMethod) Sets the offlineMethod property of the bean. |
protected
void |
setPaymentAttributes(
TypedProperty attributes) Saves the TypedProperty object containing payment attributes. |
protected
void |
setPolicyProperties(java.lang.String nvps) Sets the policyProperties property of the Bean. |
protected
void |
setShortDescription(java.lang.String description) Sets the shortDescription property of the Bean. |
protected
void |
setSupportedCurrencies(java.util.Vector vec) Sets the supportedCurrencies property of the Bean representing the currencies supported by this payment policy. |
boolean |
useWallet() Indicates whether or not this payment policy requires the use of a Wallet application. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String POLICY_PROP_ATTR_PAGE_NAME
public static final java.lang.String POLICY_PROP_CASSETTE_NAME
public static final java.lang.String POLICY_PROP_PROFILE_NAME
public static final java.lang.String POLICY_PROP_CURRENCY_ALLOWED
public static final java.lang.String POLICY_PROP_OFFLINE_METHOD
public static final java.lang.String POLICY_PROP_USE_WALLET
Constructor Detail |
---|
public PaymentPolicyInfo(PaymentPolicyInfo info)
info
- an instance of PaymentPolicyInfo whose values are to be
copied to the new instancepublic PaymentPolicyInfo(java.lang.String astrPolicyId, java.lang.String astrPolicyName, java.lang.String astrStoreEntityId)
astrPolicyId
- the policy IDastrPolicyName
- the policy nameastrStoreEntityId
- the Store Entity IDMethod Detail |
---|
public static PaymentPolicyInfo createFromAccessBean(BusinessPolicyAccessBean abPolicy, CommandContext cmdCtx) throws ECException
abPolicy
- the BusinessPolicyAccessBean for the creation of
the the new PaymentPoilicyInfo Bean instance.cmdCtx
- the CommandContextECException.
ECException
public java.lang.String getAttrPageName()
public java.lang.String getBrand()
String
representing the brand property of the
PaymentPolicyInfo object.public java.lang.String getCashierProfile()
This payment policy property specifies the name of the Cashier Profile (without the .profile suffix) to use with this policy.
This payment policy property is defined for policy that is based on WebSphere Commerce Payments cassette.
public java.lang.String getCassetteName()
This payment policy property specifies the name of the Payments cassette that the payment policy is used for.
This payment policy property is defined for policy that is based on WebSphere Commerce Payments cassette. It matches the vaule of the PAYMENTTYPE Parameter in the Cashier Profile specified with the profileName property.
public java.lang.String getLongDescription()
public java.lang.String getOfflineMethod()
This property is defined for payment policy that uses the CustomOffline Payments cassette. It matches the value specified for the $METHOD Parameter in the Cashier Profile specified with the profileName property.
String
representing the offlineMethod property of the
payment policy.public TypedProperty getPaymentAttributes()
public java.lang.String getPolicyId()
public java.lang.String getPolicyName()
public java.lang.String getPolicyType()
public java.lang.String getShortDescription()
public java.lang.String getStoreEntityId()
public java.util.Vector getSupportedCurrencies()
public boolean isNotForDefaultTC()
protected PaymentPolicyInfo newCopy()
public boolean requiresExplicitTC()
protected void setAccountNumber(java.lang.String astrNumber)
astrNumber
- the account number in String
form.protected void setAccountTitle(java.lang.String astrTitle)
astrTitle
- the account title.protected void setAttrPageName(java.lang.String pageName)
pageName
- the name of the JSP file without the .jsp
suffix.protected void setBrand(java.lang.String astrBrand)
astrBrand
- the name of the credit card
brand.protected void setCashierProfile(java.lang.String astrProfileName)
astrProfileName
- the name of the Cashier profile without the
".profile" suffix.protected void setCassetteName(java.lang.String astrCassetteName)
astrCassetteName
- the name of the
Cassette.protected void setFieldsFromPolicyAB(BusinessPolicyAccessBean abPolicy, java.lang.Integer nLanguageId) throws ECException
abPolicy
- the BusinessPolicyAccessBean representing the
Payment Policy object.nLanguageId
- the language ID that identifies the language to
be used for language-specific fileds.ECException
protected void setLongDescription(java.lang.String description)
description
- a long description of the Payment
Policy.protected void setOfflineMethod(java.lang.String offlineMethod)
offlineMethod
- the String representing the
offlineMethod.protected void setPaymentAttributes(TypedProperty attributes)
attributes
- the TypedProperty object containing the payment
attributes to save.protected void setPolicyProperties(java.lang.String nvps)
nvps
- the name-value pairs eparated by the character
'&'.protected void setShortDescription(java.lang.String description)
description
- a short description of the Payment
Policy.protected void setSupportedCurrencies(java.util.Vector vec)
vec
- the Vector containing the Strings representing the
currencies supported by this payment policy.public boolean useWallet()