|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.ibm.commerce.payment.beans.PayStatusListPMDataBean
This DataBean, when populated, provides the payment state of the specified orders as known to the Payment Manager. No information will be returned if the order is not known to the Payment Manager.
Field Summary | |
static java.lang.String |
CLASSNAME
|
static java.lang.String |
COPYRIGHT
|
Constructor Summary | |
PayStatusListPMDataBean()
MySmartDataBean constructor comment. |
Method Summary | |
java.lang.String |
getCommonAVSCode(java.lang.String orderId)
Returns the commonAVSCode from the Payment Manager 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 the Payment Manager. |
int |
getPrimaryRC()
Returns the primary return code as returned from the Payment Manager QueryOrders command. |
int |
getSecondaryRC()
Returns the secondary return code as returned from the Payment Manager 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)
Insert the method's description here. |
void |
setOrderIds(java.util.Vector vecOrderIds)
Sets the orderIds property of the Bean. |
protected void |
setPaymentStates(java.lang.String orderId,
java.lang.String paymentState)
Insert the method's description here. |
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. |
void |
setStoreId(java.lang.String astrStoreId)
Sets the storeId property of the Bean |
Field Detail |
public static final java.lang.String CLASSNAME
public static final java.lang.String COPYRIGHT
Constructor Detail |
public PayStatusListPMDataBean()
Method Detail |
public java.lang.String getCommonAVSCode(java.lang.String orderId)
String
representation of the
the common AVS code set by the Payment Manager Cassette. The Payment Manager
Cassette maps the payment service specific AVS Results Code returned by the
Address Verification Services to the common AVS code defined by the Payment
Manager Framework.
Possible values for the common AVS Code are:
String
representation of the
the common AVS code set by the Payment Manager Cassette.
If the Cassette does not use AVS, an empty String is returned.public java.util.Vector getOrderIds()
Vector
containing the objects representing the orderIds
of customer Orders.public java.lang.String getPaymentState(java.lang.String orderId)
com.ibm.etill.frame.clientapi.PaymentCommandConstants
interface.
The constants defined for payment state are:
String
representing the payment state of the order. It may
be the empty string if there is no payment for the order or if an error occurred
during the population of this DataBean.
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()
String
representing the Reference Number
of the Store to which the order belongs.public void populate() throws java.lang.Exception
java.lang.Exception
- The exception description.protected void setCommonAVSCodes(java.lang.String orderId, java.lang.String commonAVSCode)
public void setOrderIds(java.util.Vector vecOrderIds)
vecOrderIds
- the Vector
containing the objects representing the orderIds
of customer Ordersprotected void setPaymentStates(java.lang.String orderId, java.lang.String paymentState)
newPaymentStates
- java.util.Hashtableprotected 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.public void setStoreId(java.lang.String astrStoreId)
astrStoreId
- the String
representing the Reference Number
of the Store to which the order belongs.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |