com.ibm.commerce.tools.optools.returns.commands
Interface CSRDisplayRefundPaymentInfoCmd

All Superinterfaces:
BusinessPolicyCommand, TaskCommand
All Known Implementing Classes:
CSRDisplayRefundPaymentInfoCmdImpl

public interface CSRDisplayRefundPaymentInfoCmd
extends BusinessPolicyCommand

Interface to retrieve display information about the mechanism for a refund.

Usage:

  1. call setRMA
  2. call execute
  3. call getCreditAccountInformation
See Also:
com.ibm.commerce.tools.optools.returns.beans.CSRReturnSummaryDataBean

Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.String defaultCommandClassName
          Default implementation of this command.
static java.lang.String NAME
          Name of this command.
 
Method Summary
 java.util.Vector getCreditAccountInformation()
          Gets refund mechanism information for the set RMA.
 void populateCreditAccountInformation()
          Populates the object's data structure with refund mechanism dependent information.
 void setRMA( RMAAccessBean abRMA)
          Sets the RMA for which to get refund mechanism information.
 
Methods inherited from interface com.ibm.commerce.command. BusinessPolicyCommand
getPolicyId, getRequestProperties, setPolicyId, setRequestProperties
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
Name of this command.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
Default implementation of this command.
See Also:
Constant Field Values
Method Detail

getCreditAccountInformation

public java.util.Vector getCreditAccountInformation()
Gets refund mechanism information for the set RMA. Returns a Vector of Hashtables that contain Hashtables. A sample usage of the output is as follows:
    Vector creditInfo  = getCreditAccountInformation()

    if ( creditInfo != null && creditInfo.size() != 0 )
    {
       for (int i = 0; i < creditInfo.size(); i++ )
       {
     
          Hashtable ht1 = (Hashtable) creditInfo.elementAt(i);
          Enumeration enum = ht1.elements();
          Hashtable ht2 = (Hashtable) enum.nextElement(); // only 1 element in this hashtable
          String labelKey = (String) ht2.get("LABEL_KEY"); // gets the label key from the ReturnNLS.properties file
          String value = (String) ht2.get("VALUE");   // gets the value
       }
    }   

populateCreditAccountInformation

public void populateCreditAccountInformation()
                                      throws java.lang.Exception
Populates the object's data structure with refund mechanism dependent information.
Throws:
java.lang.Exception

setRMA

public void setRMA(RMAAccessBean abRMA)
Sets the RMA for which to get refund mechanism information.
Parameters:
abRMA - RMA access bean to use