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

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

public interface CSRDisplayRefundPaymentInfoCmd
extends BusinessPolicyCommand

Brief Description:


  Interface to retrieve and display information about the account the refund will be credited to.

Input parameters:

  RMAAccessBean - set the RMAAcessBean using the setRMA(...) method
 
Output parameters:

  The commands that implement this interface will populate a data structure with the credit account information.
  To retrive the data structure call the getCreditAccountInformation() method.

  This method 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
		   }
		}   


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
           
static java.lang.String NAME
           
 
Method Summary
 java.util.Vector getCreditAccountInformation()
          Gets the refund credit account information
 void populateCreditAccountInformation()
          Gets the refund credit account information and stores it into objects data structure.
 void setRMA(RMAAccessBean abRMA)
          The RMA to refund to.
 
Methods inherited from interface com.ibm.commerce.command.BusinessPolicyCommand
getPolicyId, getRequestProperties, setPolicyId, setRequestProperties
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName

NAME

public static final java.lang.String NAME
Method Detail

getCreditAccountInformation

public java.util.Vector getCreditAccountInformation()
Gets the refund credit account information

populateCreditAccountInformation

public void populateCreditAccountInformation()
                                      throws java.lang.Exception
Gets the refund credit account information and stores it into objects data structure. To get the data structure call the method getCreditAccountInformation().

setRMA

public void setRMA(RMAAccessBean abRMA)
The RMA to refund to.
Parameters:
abRMA - The RMA access bean to use.