com.ibm.commerce.payment.beans
Class PayStatusListPMDataBean

com.ibm.commerce.payment.beans.PayStatusListPMDataBean

public class 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

CLASSNAME

public static final java.lang.String CLASSNAME

COPYRIGHT

public static final java.lang.String COPYRIGHT
Constructor Detail

PayStatusListPMDataBean

public PayStatusListPMDataBean()
MySmartDataBean constructor comment.
Method Detail

getCommonAVSCode

public java.lang.String getCommonAVSCode(java.lang.String orderId)
Returns the commonAVSCode from the Payment Manager for the specified Order. The commonAVSCode property is the 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:
Returns:
the 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.

getOrderIds

public java.util.Vector getOrderIds()
Returns the orderIds property of the Bean. The orderIds property is a Vector of objects representing the orderIds of customer Orders. This is the Vector of objects that the user of the DataBean specified using the setOrderIds() method.
Returns:
the Vector containing the objects representing the orderIds of customer Orders.

getPaymentState

public java.lang.String getPaymentState(java.lang.String orderId)
Returns the payment state of the Order known to 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:
Returns:
the 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.

getPrimaryRC

public int getPrimaryRC()
Returns the primary return code as returned from the Payment Manager QueryOrders command.
Returns:
the primary return code from the Payment Manager QueryOrders command or -1 if an error occurred before the QueryOrders command was issued.

getSecondaryRC

public int getSecondaryRC()
Returns the secondary return code as returned from the Payment Manager QueryOrders command.
Returns:
the secondary return code from the Payment Manager QueryOrders command or -1 if an error occurred before the QueryOrders command was issued.

getStoreId

public java.lang.String getStoreId()
Returns the storeId property of the Bean
Returns:
the String representing the Reference Number of the Store to which the order belongs.

populate

public void populate()
              throws java.lang.Exception
Populate the Bean Properties. This method is called by the DataBeanManager during DataBean activation.
Throws:
java.lang.Exception - The exception description.

setCommonAVSCodes

protected void setCommonAVSCodes(java.lang.String orderId,
                                 java.lang.String commonAVSCode)
Insert the method's description here.

setOrderIds

public void setOrderIds(java.util.Vector vecOrderIds)
Sets the orderIds property of the Bean. The orderIds property is a Vector of objects representing the orderIds of customer Orders. The objects could be Strings or Integers or Long. The DataBean does not check. It simply pass the Vector to Payment Manager.
Parameters:
vecOrderIds - the Vector containing the objects representing the orderIds of customer Orders

setPaymentStates

protected void setPaymentStates(java.lang.String orderId,
                                java.lang.String paymentState)
Insert the method's description here. Creation date: (8/1/00 5:39:03 PM)
Parameters:
newPaymentStates - java.util.Hashtable

setPrimaryRC

protected void setPrimaryRC(int anPrimaryRC)
Sets the primary return code as returned from the Payment Manager QueryOrders command.
Parameters:
anPrimaryRC - the primary return code as returned from the Payment Manager QueryOrders command.

setSecondaryRC

protected void setSecondaryRC(int anSecondaryRC)
Sets the secondary return code as returned from the Payment Manager QueryOrders command.
Parameters:
anSecondaryRC - the secondary return code as returned from the Payment Manager QueryOrders command.

setStoreId

public void setStoreId(java.lang.String astrStoreId)
Sets the storeId property of the Bean
Parameters:
astrStoreId - the String representing the Reference Number of the Store to which the order belongs.