java.lang.Objectcom.ibm.commerce.beans.InputDataBeanImpl
com.ibm.commerce.beans.SmartDataBeanImpl
com.ibm.commerce.payment.beans.PayStatusListPMDataBean
This DataBean, when populated, provides the payment state of the specified orders as known by WebSphere Commerce Payments. No information will be returned if the order is not known to the Payments.
Field Summary | |
static java.lang.String | CLASSNAME The name of this class. |
static java.lang.String | COPYRIGHT IBM Copyright |
Fields inherited from class com.ibm.commerce.beans.SmartDataBeanImpl |
commandContext |
Fields inherited from class com.ibm.commerce.beans.InputDataBeanImpl |
requestProperties |
Fields inherited from interface com.ibm.commerce.beans.DataBean |
emptyString |
Constructor Summary | |
PayStatusListPMDataBean() PayStatusListPMDataBean default constructor. |
Method Summary | |
java.lang.String | getCommonAVSCode(java.lang.String orderId) Returns the commonAVSCode from WebSphere Commerce Payments for the specified Order. |
java.util.Vector | getOrderIds() Returns the orderIds property of the Bean. |
java.lang.String | getPaymentState(java.lang.String orderId) Returns the payment state of the order known to WebSphere Commerce Payments. |
int | getPrimaryRC() Returns the primary return code as returned from the WebSphere Commerce Payments QueryOrders command. |
int | getSecondaryRC() Returns the secondary return code as returned from the WebSphere Commerce Payments QueryOrders command. |
java.lang.String | getStoreId() Returns the storeId property of the Bean |
void | populate() Populate the Bean Properties. |
protected void | setCommonAVSCodes(java.lang.String orderId, java.lang.String commonAVSCode) Saves the common AVS Code for the specified order. |
void | setOrderIds(java.util.Vector vecOrderIds) Sets the orderIds property of the Bean. |
protected void | setPaymentStates(java.lang.String orderId, java.lang.String paymentState) Saves the payment state for the specified order. |
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. |
void | setStoreId(java.lang.String astrStoreId) Sets the storeId property of the Bean |
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 |
public static final java.lang.String COPYRIGHT
public static final java.lang.String CLASSNAME
Constructor Detail |
public PayStatusListPMDataBean()
Method Detail |
public java.lang.String getCommonAVSCode(java.lang.String orderId)
The commonAVSCode property is the String representation of the the common AVS code set by the payment cassette. The payment cassette maps the payment service specific AVS Results Code returned by the Address Verification Services (AVS) to the WebSphere Commerce Payments defined common AVS code.
Possible values for the common AVS Code are:
public java.util.Vector getOrderIds()
public java.lang.String getPaymentState(java.lang.String orderId)
Possible values for the payment state are defined in the com.ibm.etill.frame.clientapi.PaymentCommandConstants interface.
The constants defined for payment state are:
If there are more than one payment for an order then the payment state of one of the payments will be used if it is not PAYMENTSTATE_VOID.
The value for the PAYMENTSTATE_VOID constant will be returned if and only if all the payments for the order have the payment state equals to the constant in PAYMENTSTATE_VOID.
public int getPrimaryRC()
public int getSecondaryRC()
public java.lang.String getStoreId()
public void populate() throws java.lang.Exception
protected void setCommonAVSCodes(java.lang.String orderId, java.lang.String commonAVSCode)
public void setOrderIds(java.util.Vector vecOrderIds)
protected void setPaymentStates(java.lang.String orderId, java.lang.String paymentState)
protected void setPrimaryRC(int anPrimaryRC)
protected void setSecondaryRC(int anSecondaryRC)
public void setStoreId(java.lang.String astrStoreId)
(C) Copyright IBM Corporation 1996, 2005. All Rights Reserved.