|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.ibm.commerce.payment.beans.PayStatusPMDataBean
This DataBean, when populated, provides the order state and payment state of the specified order as known by the Payment Manager. The order must be one that has been sent to the Payment Manager for processing. No information will be returned if the order is not known to the Payment Manager. This DataBean is designed for the use of JavaServer Pages that may be invoked during shopping flow to display the payment status of an order owned by the shopper. No information will be returned if the shopper is not the owner of the specified order.
Constructor Summary | |
PayStatusPMDataBean()
PayStatusPMDataBean default constructor. |
Method Summary | |
java.lang.String |
getCommonAVSCode()
Returns the commonAVSCode property of the Bean. |
protected long |
getElapsedTimeMillis()
Returns the elapsedTimeMillis property of the Bean. |
java.lang.String |
getMessage()
Returns the message property of the Bean. |
java.lang.String |
getOrderId()
Returns the orderId property of the Bean |
java.lang.String |
getOrderState()
Returns the orderState property of the Bean. |
java.lang.String |
getOrderStatus()
Returns the orderStatus property of the Bean. |
java.lang.String |
getPaymentState()
Returns the paymentState property of the Bean. |
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 |
setCommonAVSCode(java.lang.String astrCommonAVSCode)
Sets the commonAVSCode property of the Bean. |
protected void |
setElapsedTimeMillis(long anElapsedTimeMillis)
Sets the elapsedTimeMillis property of the Bean. |
protected void |
setMessage(java.lang.String astrMessage)
Sets the message property of the Bean. |
protected void |
setOrderId(java.lang.String astrOrderId)
Sets the orderId property of the Bean |
protected void |
setOrderState(java.lang.String astrOrderState)
Sets the orderState property of the Bean. |
protected void |
setOrderStatus(java.lang.String astrOrderStatus)
Sets the orderStatus property of the Bean. |
protected void |
setPaymentNumber(java.lang.String astrPaymentNumber)
Sets the paymentNumber property of the Bean. |
protected void |
setPaymentState(java.lang.String astrPaymentState)
Sets the paymentState property of the Bean. |
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. |
protected void |
setStoreId(java.lang.String astrStoreId)
Sets the storeId property of the Bean |
Constructor Detail |
public PayStatusPMDataBean()
Method Detail |
public java.lang.String getCommonAVSCode()
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 Payment Manager Framework defined
common AVS code.
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.protected long getElapsedTimeMillis()
public java.lang.String getMessage()
public java.lang.String getOrderId()
String
representing the Reference Number of the Order.public java.lang.String getOrderState()
String
representing the
Payment Manager state of the order. Possible values are defined in the
com.ibm.etill.frame.clientapi.PaymentCommandConstants
interface.
The constants defined for order state are:
String
representing the Payment Manager state of the order.
It may be the empty string if no order state is known by the Payment Manager or if
an error occurred during the population of this DataBean.public java.lang.String getOrderStatus()
String
representing the
status of the order. Possible values are:
String
representing the status of the order.
It may be the empty string if an error occurred during the population
of this DataBean.public java.lang.String getPaymentState()
String
representing the
payment state of the order known by the Payment Manager.
Possible values for the payment state are defined in the
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 setCommonAVSCode(java.lang.String astrCommonAVSCode)
astrCommonAVSCode
- java.lang.String the String
representation of the
the common AVS code
See also getCommonAVSCode()
for additional information.protected void setElapsedTimeMillis(long anElapsedTimeMillis)
anElapsedTimeMillis
- the elapsed time in milliseconds
for the Payment Manager QueryOrders command to run and get the results back.protected void setMessage(java.lang.String astrMessage)
astrMessage
- the String
used to set the message property
of the Bean.protected void setOrderId(java.lang.String astrOrderId)
astrOrderId
- the String
representing the Reference Number of the Orderprotected void setOrderState(java.lang.String astrOrderState)
astrOrderState
- the String
representing the Payment Manager
state of the order.
See also getOrderState()
for additional information.protected void setOrderStatus(java.lang.String astrOrderStatus)
astrOrderStatus
- the single character String
representing the
status of the order.
See also getOrderStatus()
for additional information.protected void setPaymentNumber(java.lang.String astrPaymentNumber)
astrPaymentNumber
- the String
representing the payment
number of the payment with payment state stored in the paymentState property
of the Bean.protected void setPaymentState(java.lang.String astrPaymentState)
astrPaymentState
- the String
representing the payment
state of the order known by the Payment Manager .
See also getPaymentState()
for additional information.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.protected 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 |