public class UsablePaymentTCListDataBean extends SmartDataBeanImpl implements com.ibm.commerce.payment.beans.UsablePaymentTCListInputDataBean, com.ibm.commerce.payment.beans.UsablePaymentTCListSmartDataBean, Delegator
Modifier and Type | Field and Description |
---|---|
protected java.util.Hashtable | ihshPaymentTCInfoByTradingId
Hashtable for storing the set of PaymentTCInfo Beans by Trading Agreement ID for all the oder items in the specified order.
|
protected java.util.Vector | ivecCommonPaymentTCInfo
Vector for storing the PaymentTCInfo Beans representing Payment Terms and Conditions that are common across all Trading Agreements specified by the order items.
|
protected java.util.Vector | ivecIdsOfTAWithNoPaymentTC
Vector for storing the IDs of Trading Agreement with no explicit Payment Terms and Conditions that are specified by the order items of this order.
|
protected java.util.Vector | ivecTradingIds
Vector for storing the different Trading Agreement IDs for this order
|
protected java.util.Vector | ivecUsablePaymentTCInfo
Vector for storing the PaymentTCInfo Beans representing usable Payment Terms and Conditions for this order.
|
Constructor and Description |
---|
UsablePaymentTCListDataBean()
UsablePaymentTCListDataBean default constructor.
|
Modifier and Type | Method and Description |
---|---|
protected void | completeCommonPaymentTCInfo()
Completes the properties in the common PaymentTCInfo bean.
|
protected java.util.Vector | createDefaultPaymentTCInfoFromStoreSupportedPolicies()
Returns a Vector of PaymentTCInfo Beans created from the set of supported Payment Policies for the Store.
|
protected void | findCommonPaymentTCForOrderItems()
Finds the common Payment Terms and Conditions (TCs) from all the Payment TCs specified.
|
protected void | findPaymentTCInfoByTAFromOrderItems()
Fills the Hashtable containing vectors of PaymentTCInfo beans keyed by Trading Agreement ID for the order items in the Order.
|
protected void | findUsablePaymentTCFromCommon()
Finds the usable Payment Terms and Conditions (TCs) from the vector of common Payment TCs specified by the Trading Agreements of order items.
|
Protectable | getDelegate()
Retrieves its delegate.
|
PaymentTCInfo[] | getFilteredPaymentTCInfo()
Returns a filtered array of PaymentTCInfo bean representing payment terms and conditions that could be used to pay for the specified Order.
|
java.lang.String | getMessage()
Returns the message property of the Bean.
|
protected OrderAccessBean | getOrderAccessBean()
Returns the OrderAccessBean representing the order specified by the orderId input parameter.
|
protected OrderDataBean | getOrderDataBean()
Returns the OrderDataBean representing the order specified by the orderId input parameter.
|
protected java.util.Hashtable | getPaymentPolicyInfoForCurrencyBySupportedCassette()
Returns a Hashtable containing vectors of PaymentPolicyInfo beans keyed by supported cassette.
|
java.lang.Exception | getPaymentSystemException()
Returns any Exception thrown by the Payment System during the activation of the DataBean or null.
|
PaymentTCInfo[] | getPaymentTCInfo()
Returns an array of PaymentTCInfo bean representing payment terms and conditions that could be used to pay for the specified Order.
|
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.
|
protected java.lang.Integer | getStoreIdFromOrder()
Returns the Store Entity ID from the order specified as input parameter for the activation of this DataBean.
|
void | populate()
Populate the Bean Properties.
|
void | setCompatibleMode(java.lang.String compatibleMode)
Sets the compatible mode of the payment policy.
|
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.
|
void | setOrderId(java.lang.Long aOrderId)
Sets the orderId property of the Bean.
|
protected void | setPaymentSystemException(java.lang.Exception exc)
Saves the Exception object returned by the Payment System during the activation of this DataBean.
|
protected void | setPrimaryRC(int anPrimaryRC)
Sets the primary return code as returned from the WebSphere Commerce Payments QueryOrders command.
|
void | setReturnAllUsableTC(boolean returnAllUsableTC)
This method sets the flag that indicating whether to return all the usable payment policies when there are multiple payment policies with the same name.
|
protected void | setSecondaryRC(int anSecondaryRC)
Sets the secondary return code as returned from the WebSphere Commerce Payments QueryOrders command.
|
protected java.util.Hashtable ihshPaymentTCInfoByTradingId
protected java.util.Vector ivecTradingIds
protected java.util.Vector ivecIdsOfTAWithNoPaymentTC
protected java.util.Vector ivecCommonPaymentTCInfo
protected java.util.Vector ivecUsablePaymentTCInfo
public UsablePaymentTCListDataBean()
protected void completeCommonPaymentTCInfo() throws ECException
protected java.util.Vector createDefaultPaymentTCInfoFromStoreSupportedPolicies() throws ECException
protected void findCommonPaymentTCForOrderItems() throws ECException
protected void findPaymentTCInfoByTAFromOrderItems() throws ECException
protected void findUsablePaymentTCFromCommon() throws ECException
public Protectable getDelegate() throws java.lang.Exception
For the UsablePaymentTCListDataBean, the getDelegate() method returns the OrderDataBean specified by the order ID. The OrderDataBean object is the Protectable object whose access control policies will indirectly control the access control for this object
public java.lang.String getMessage()
This is mainly for diagnostics purposes.
protected OrderAccessBean getOrderAccessBean() throws ECException
protected OrderDataBean getOrderDataBean() throws ECException
protected java.util.Hashtable getPaymentPolicyInfoForCurrencyBySupportedCassette() throws ECException
public java.lang.Exception getPaymentSystemException()
This is useful for diagnostics or for determining whether to display a user-friendly message to the customer. This is used 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 WebSphere Commerce Payments.
public PaymentTCInfo[] getPaymentTCInfo()
public PaymentTCInfo[] getFilteredPaymentTCInfo()
public int getPrimaryRC()
This is mainly for diagnostics purposes.
public int getSecondaryRC()
This is mainly for diagnostics purposes.
protected java.lang.Integer getStoreIdFromOrder() throws ECException
public void populate() throws java.lang.Exception
protected void setLanguageId(java.lang.Integer aLanguageId)
protected void setMessage(java.lang.String astrMessage)
The message property stores any message received during population of the Bean. It may be null.
public void setOrderId(java.lang.Long aOrderId)
public void setCompatibleMode(java.lang.String compatibleMode)
protected void setPaymentSystemException(java.lang.Exception exc)
protected void setPrimaryRC(int anPrimaryRC)
protected void setSecondaryRC(int anSecondaryRC)
public void setReturnAllUsableTC(boolean returnAllUsableTC)