java.lang.Object | +--com.ibm.commerce.payment.beans.PaymentPolicyInfo | +--com.ibm.commerce.payment.beans.PaymentTCInfo
The class PaymentTCInfo is a data holder that is used by the UsablePaymentTCListDataBean to hold information about the PaymentTC and the Payment Policy specified by the PaymentTC.
Field Summary |
---|
Fields inherited from class com.ibm.commerce.payment.beans. PaymentPolicyInfo |
POLICY_PROP_ATTR_PAGE_NAME,
POLICY_PROP_CASSETTE_NAME,
POLICY_PROP_CURRENCY_ALLOWED,
POLICY_PROP_OFFLINE_METHOD,
POLICY_PROP_PROFILE_NAME,
POLICY_PROP_USE_WALLET |
Constructor Summary | |
---|---|
PaymentTCInfo(
PaymentPolicyInfo policyInfo) PaymentTCInfo constructor from a PaymentPolicyInfo object. | |
PaymentTCInfo(java.lang.String astrTCId,
java.lang.String astrTCSubType, java.lang.String astrDisplayName,
java.lang.String astrBillToAddrId,
BusinessPolicyAccessBean abPolicy, java.lang.String astrPolicyId,
java.lang.String astrPolicyName,
java.lang.String astrStoreEntityId) PaymentTCInfo constructor. |
Method Summary | |
---|---|
boolean |
compatibleWith(java.util.Vector vecPaymentTCInfo) Check if this PaymentTCInfo is compatible with at least one of the PaymentTCInfo object in the specified Vector of PaymentTCInfo objects. |
static
PaymentTCInfo |
createPaymentTCInfoFromAB(
TermConditionAccessBean abTC) Creates a PaymentTCInfo object from a PaymentTC AccessBean. |
static
PaymentTCInfo |
createPaymentTCInfoFromAB(
TermConditionAccessBean abTC, java.lang.Integer nLangId) Creates a PaymentTCInfo object from a PaymentTC AccessBean and sets all the other fields from the Payment Policy associated with the PaymentTC. |
static java.util.Vector |
findCommonPaymentTCInfo(java.util.Hashtable hshPaymentTCInfoByTradingId,
boolean bExcludePoliciesThatRequireExplicitTC) Helper method that returns a Vector of common PaymentTCInfo beans from a Hashtable of Vectors of PaymentTCInfo bean keyed by Trading Agreement ID. |
protected
static TypedProperty |
getAttributesFromTC(
TermConditionAccessBean abTC) Gets all the Attributes for the specified Payment Terms and Conditions. |
static java.lang.String |
getAttrStringFromTC(
TermConditionAccessBean abTC) Utility method for obtaining the Attributes of the Payment Terms and Conditions in String form (for example, n1=v1&n2=v2&n3=v3......). |
protected
static java.lang.String |
getAttrStringFromTypedProperty(
TypedProperty prop) Gets the Payment Attributes in a single String in alphabetical order of the attribute name (for example, n1=v1&n2=v2&n3=v3.....) and separated by '&'. |
java.lang.String |
getBillToAddressId() Returns the ID of the billToAddress specified with this PaymentTC. |
static java.lang.String |
getBillToAddrIdFromTC(
TermConditionAccessBean abTC) Helper methods that returns ID of the billTo address specified with a Payment Terms and Conditions. |
protected
BusinessPolicyAccessBean |
getBusinessPolicy() Returns the business policy that this Payment Terms and Conditions is based on. |
java.lang.String |
getTCAttrString() Returns the Attributes of this PaymentTC in String form with each name-value pair separated by '&'. |
java.lang.String |
getTCDisplayName() Returns the display name of this PaymentTC. |
java.lang.String |
getTCId() Returns the internal ID of this PaymentTC in String. |
java.lang.String |
getTCSubType() Returns the TCSubtype of this PaymentTC. |
protected
boolean |
isSupportedByPaymentPolicy(java.util.Vector paymentPolicyInfo) Checks if the PaymentTC represented by this PaymentTCInfo bean is supported by the Payment Policies represented by the specified Vector of PaymentPolicyInfo beans. |
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 |
setTCAttrString(java.lang.String strAttributes) Sets the TC Attribute-String. |
protected
void |
setTCAttrString(
TypedProperty prop) Sets the TC Attribute-String using the names and values from the TypedProperty. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Constructor Detail |
---|
public PaymentTCInfo(PaymentPolicyInfo policyInfo)
policyInfo
- the PaymentPolicyInfo object from which the
PaymentTCInfo bean is to be created.
PaymentPolicyInfo
public PaymentTCInfo(java.lang.String astrTCId, java.lang.String astrTCSubType, java.lang.String astrDisplayName, java.lang.String astrBillToAddrId, BusinessPolicyAccessBean abPolicy, java.lang.String astrPolicyId, java.lang.String astrPolicyName, java.lang.String astrStoreEntityId)
astrTCId
- the ID of this PaymentTC. May be an empty
string.astrTCSubType
- the PaymentTC subtype. For PaymentTC, the
subtype is "PaymentTC".astrDisplayName
- the display name of this PaymentTC.astrBillToAddrId
- the ID of the billto Address. May be an
empty string if there is no billto address specified.abPolicy
- the BusinessPolicyAccessBean reprsenting the
payment business policy that this PaymentTC is based on.astrPolicyId
- the ID of the payment business policy.astrPolicyName
- the name of the payment business policy.astrStoreEntityId
- the Store Entity ID of the payment
business policy.Method Detail |
---|
public boolean compatibleWith(java.util.Vector vecPaymentTCInfo)
vecPaymentTCInfo
- a Vector of PaymentTCInfo objectspublic static PaymentTCInfo createPaymentTCInfoFromAB(TermConditionAccessBean abTC) throws ECException
abTC
- the PaymentTCAccessBean from which the PaymentTCInfo
bean is to be created.ECException
public static PaymentTCInfo createPaymentTCInfoFromAB(TermConditionAccessBean abTC, java.lang.Integer nLangId) throws ECException
abTC
- the PaymentTCAccessBean from which the PaymentTCInfo
bean is to be created.nLangId
- the language ID that identifies the language to be
used for language-specific fileds.ECException
public static java.util.Vector findCommonPaymentTCInfo(java.util.Hashtable hshPaymentTCInfoByTradingId, boolean bExcludePoliciesThatRequireExplicitTC) throws ECException
A Payment Terms and Conditions is common if the same terms and conditions appear in each the the Vector of PaymentTCInfo Beans.
bExcludePoliciesThatRequireExplicitTC
- true to exclude
payment policies that require explicit payment terms and conditionsECException.
ECException
protected static TypedProperty getAttributesFromTC(TermConditionAccessBean abTC) throws ECException
abTC
- the TermConditionAccessBean representing the Payment
Terms and ConditionsECException.
ECException
public static java.lang.String getAttrStringFromTC(TermConditionAccessBean abTC) throws ECException
abTC
- the PaymentTCAccessBean representing the Payment Terms
and ConditionsECException.
ECException
protected static java.lang.String getAttrStringFromTypedProperty(TypedProperty prop)
Note: Attributes with empty value are dropped.
prop
- the TypedProperty containing the names and values of
the Payment Attributes.public java.lang.String getBillToAddressId()
public static java.lang.String getBillToAddrIdFromTC(TermConditionAccessBean abTC) throws ECException
abTC
- the PaymentTCAccessBean representing the Payment Terms
and ConditionsECException.
ECException
protected BusinessPolicyAccessBean getBusinessPolicy()
public java.lang.String getTCAttrString()
public java.lang.String getTCDisplayName()
public java.lang.String getTCId()
public java.lang.String getTCSubType()
protected boolean isSupportedByPaymentPolicy(java.util.Vector paymentPolicyInfo)
Assumption: the Vector of PaymentPolicyInfo Beans are all from the same payment cassette
protected void setFieldsFromPolicyAB(BusinessPolicyAccessBean abPolicy, java.lang.Integer nLanguageId) throws ECException
setFieldsFromPolicyAB
in class
PaymentPolicyInfo
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 setTCAttrString(TypedProperty prop)
prop
- the TypedProperty object containing the names and
values of the TC Attributes.protected void setTCAttrString(java.lang.String strAttributes)
strAttributes
- the TC Attributes in name-value pairs
separated by '&'. For example,
n1=v1&n2=v2&n3=v3......