com.ibm.commerce.tools.optools.order.commands
Interface CSROrderCommentsAddCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable, ToolsControllerCommand
All Known Implementing Classes:
CSROrderCommentsAddCmdImpl

public interface CSROrderCommentsAddCmd
extends ToolsControllerCommand

 Add a comment to orders.  If the sendEmail flag is set to true in the XML, this command will call command CSROrderCommentsNotify to send emails to the email address specified.

 URL calling syntax:
		Https://host_name/path/CSROrderCommentsAdd?XML=xml_string&URL=return_url

 Parameters:
		XML
			An input xml_string that contains all the required data to this command.

			Example xml_string:
				<?xml version="1.0" encoding "UTF-8">
				<selectedOrders>12345</selectedOrders>
				<newComment>The User has requested to change the orders.</newComment>
				<sendEmail>false</sendEmail>
				<email>jane@ibm.com</email>
				</xml>

		URL
			The URL to be called when the command completes successfully.


 Response Parameters:
		None.

 Exceptions:
		It throws all the exceptions that the CSROrderCommentsNotify command will throw.


 


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
          The default implementation class.
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.tools.optools.order.commands.CSROrderCommentsAddCmd".
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class.

NAME

public static final java.lang.String NAME
The name of this interface is "com.ibm.commerce.tools.optools.order.commands.CSROrderCommentsAddCmd".