|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
Field Summary | |
protected java.util.Hashtable |
ihshPaymentTCInfoByTradingId
|
protected java.util.Vector |
ivecCommonPaymentTCInfo
|
protected java.util.Vector |
ivecIdsOfTAWithNoPaymentTC
|
protected java.util.Vector |
ivecTradingIds
|
protected java.util.Vector |
ivecUsablePaymentTCInfo
|
Fields inherited from interface com.ibm.commerce.security.Delegator |
COPYRIGHT |
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 PaymentTCs from all the PaymentTCs 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 PaymentTCs from the vector of common PaymentTCs that the Trading Agreements of order items specify. |
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 keys by supported Cassette. |
java.lang.Exception |
getPaymentSystemException()
Returns a null or any Exception thrown by the Payment System client during the activation of the DataBean. |
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 Payment Manager QueryAccounts command. |
int |
getSecondaryRC()
Returns the secondary return code as returned from the Payment Manager 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 client during the activation of this DataBean. |
protected void |
setPrimaryRC(int anPrimaryRC)
Sets the primary return code as returned from the Payment Manager QueryOrders command. |
protected void |
setSecondaryRC(int anSecondaryRC)
Sets the secondary return code as returned from the Payment Manager QueryOrders command. |
Field Detail |
protected java.util.Hashtable ihshPaymentTCInfoByTradingId
protected java.util.Vector ivecCommonPaymentTCInfo
protected java.util.Vector ivecIdsOfTAWithNoPaymentTC
protected java.util.Vector ivecTradingIds
protected java.util.Vector ivecUsablePaymentTCInfo
Constructor Detail |
public UsablePaymentTCListDataBean()
Method Detail |
protected void completeCommonPaymentTCInfo() throws ECException
ECException.
- protected java.util.Vector createDefaultPaymentTCInfoFromStoreSupportedPolicies() throws ECException
ECException.
- protected void findCommonPaymentTCForOrderItems() throws ECException
ECException.
- protected void findPaymentTCInfoByTAFromOrderItems() throws ECException
ECException.
- protected void findUsablePaymentTCFromCommon() throws ECException
ECException.
- public Protectable getDelegate() throws java.lang.Exception
For the UsablePaymentTCListDataBean, the getDelegate() method returns the OrderDataBean specified by the orderId.
getDelegate
in interface Delegator
java.lang.Exception
- 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
ECException.
- 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 the Payment Manager.
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.
- public void populate() throws java.lang.Exception
Exception.
- protected void setLanguageId(java.lang.Integer aLanguageId)
aLanguageId
- the Integer
representing the Reference Number
of the preferred Language of the requester.protected void setMessage(java.lang.String astrMessage)
astrMessage
- the String
used to set the message property
of the Bean.public void setOrderId(java.lang.Long aOrderId)
aOrderId
- the reference number of the customer order.protected void setPaymentSystemException(java.lang.Exception exc)
exc
- the Exception object returned by the Payment System client.protected void setPrimaryRC(int anPrimaryRC)
anPrimaryRC
- the primary return code as returned from the Payment Manager QueryOrders
command.protected void setSecondaryRC(int anSecondaryRC)
anSecondaryRC
- the secondary return code as returned from the Payment Manager
QueryOrders command.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |