java.lang.Object | +--com.ibm.commerce.beans.InputDataBeanImpl | +--com.ibm.commerce.beans.SmartDataBeanImpl | +--com.ibm.commerce.payment.beans.UsablePaymentTCListDataBean
This DataBean, when populated, gives a list of PaymentTCInfo bean representing Payment Terms and Conditions that could be used to pay for the order specified as input parameter before the DataBean is activated.
PaymentTCInfo
, Serialized
Form
Field Summary | |
---|---|
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. |
Fields inherited from class com.ibm.commerce.beans. SmartDataBeanImpl |
commandContext,
COPYRIGHT |
Fields inherited from class com.ibm.commerce.beans. InputDataBeanImpl |
requestProperties |
Fields inherited from interface com.ibm.commerce.beans. DataBean |
emptyString |
Constructor Summary | |
---|---|
UsablePaymentTCListDataBean() UsablePaymentTCListDataBean default constructor. |
Method Summary | |
---|---|
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 by the various Trading Agreements used by the order items in the Order. |
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. |
com.ibm.commerce.security.Protectable |
getDelegate() Retrieves its delegatee. |
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. |
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. |
protected
void |
setSecondaryRC(int anSecondaryRC) Sets the secondary return code as returned from the WebSphere Commerce Payments QueryOrders command. |
Methods inherited from class com.ibm.commerce.beans. SmartDataBeanImpl |
fulfills,
getCommandContext,
getResources,
setCommandContext |
Methods inherited from class com.ibm.commerce.beans. InputDataBeanImpl |
getRequestProperties,
setRequestProperties |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Methods inherited from interface com.ibm.commerce.beans. InputDataBean |
getRequestProperties,
setRequestProperties |
Field Detail |
---|
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
Constructor Detail |
---|
public UsablePaymentTCListDataBean()
Method Detail |
---|
protected void completeCommonPaymentTCInfo() throws ECException
ECException.
ECException
protected java.util.Vector createDefaultPaymentTCInfoFromStoreSupportedPolicies() throws ECException
ECException.
ECException
PaymentTCInfo
protected void findCommonPaymentTCForOrderItems() throws ECException
ECException.
ECException
protected void findPaymentTCInfoByTAFromOrderItems() throws ECException
ECException.
ECException
protected void findUsablePaymentTCFromCommon() throws ECException
ECException.
ECException
public com.ibm.commerce.security.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
java.lang.Exception
public java.lang.String getMessage()
This is mainly for diagnostics purposes.
protected OrderAccessBean getOrderAccessBean() throws ECException
ECException
protected OrderDataBean getOrderDataBean() throws ECException
ECException
protected java.util.Hashtable getPaymentPolicyInfoForCurrencyBySupportedCassette() throws ECException
ECException.
ECException
PaymentPolicyInfo
public java.lang.Exception getPaymentSystemException()
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 WebSphere Commerce Payments.
public PaymentTCInfo[] getPaymentTCInfo()
PaymentTCInfo
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
ECException.
ECException
public void populate() throws java.lang.Exception
populate
in interface
SmartDataBean
populate
in class
SmartDataBeanImpl
Exception.
java.lang.Exception
- should not happen since there is no data
retrieved to populate the databean.protected void setLanguageId(java.lang.Integer aLanguageId)
aLanguageId
- the internal ID of the preferred Language of the
requester.protected void setMessage(java.lang.String astrMessage)
The message property stores any message received during population of the Bean. It may be null.
astrMessage
- the String messagepublic void setOrderId(java.lang.Long aOrderId)
aOrderId
- the ID of the customer order.protected void setPaymentSystemException(java.lang.Exception exc)
exc
- the Exception object from the Payment
Systemprotected void setPrimaryRC(int anPrimaryRC)
anPrimaryRC
- the primary return code from the QueryOrders
commandprotected void setSecondaryRC(int anSecondaryRC)
anSecondaryRC
- the secondary return code from the QueryOrders
command