com.ibm.commerce.usermanagement.commands
Interface ProcessRequestPropertiesCmd

All Superinterfaces:
ECCommand, TaskCommand
All Known Implementing Classes:
ProcessRequestPropertiesCmdImpl

public interface ProcessRequestPropertiesCmd
extends TaskCommand

This task command is used to process request properties for URL commands.

If the request properties contain 'XML' parameter, it assumes that the URL command is called in tools framework; otherwise it assumes the URL command is directly called from URL.
If called from tools framework, the command will process the request properties to convert the xml file to name-value pair stored in TypedProperty.
The task command also generates a response properties, set 'viewTaskName' property to 'RedirectView'. If called from tools framework, it also put 'XMLFile' and 'redirectURL' properties.
Inputs of this task command are:

 setRequestProperties(TypedProperty)
 - sets request properties need to be processed.
 setCheckURL(boolean)
 - sets the indicator which determines if the task command needs to check the 'URL' parameter is not null and its length large than 0.
   default is true.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
           
static java.lang.String NAME
           
 
Method Summary
 boolean getCheckURL()
          Gets the indicator which determines if the task command needs to check the 'URL' parameter is not null and its length large than 0.
 TypedProperty getRequestProperties()
          Gets the request properties processed.
 TypedProperty getResponseProperties()
          Gets the response properties generated.
 java.lang.String getXMLFile()
          Gets the value of the parameter 'XMLFile' in the request properties.
 boolean isToolsFramework()
          Gets a boolean value indicating if the URL command is called from tools framework.
 void setCheckURL(boolean abCheckURL)
          Sets the indicator which determines if the task command needs to check the 'URL' parameter is not null and its length large than 0.
 void setRequestProperties(TypedProperty aRequestProperties)
          sets the request properties need to be processed.
 
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

getCheckURL

public boolean getCheckURL()
Gets the indicator which determines if the task command needs to check the 'URL' parameter is not null and its length large than 0. Default is true.
Returns:
The indicator which determines if the task command needs to check the 'URL' parameter

getRequestProperties

public TypedProperty getRequestProperties()
Gets the request properties processed.
Returns:
The request properties processed

getResponseProperties

public TypedProperty getResponseProperties()
Gets the response properties generated.
Returns:
The response properties generated

getXMLFile

public java.lang.String getXMLFile()
Gets the value of the parameter 'XMLFile' in the request properties.
Returns:
The value of the parameter 'XMLFile' in the request properties

isToolsFramework

public boolean isToolsFramework()
Gets a boolean value indicating if the URL command is called from tools framework.
Returns:
A boolean value indicating if the URL command is called from tools framework

setCheckURL

public void setCheckURL(boolean abCheckURL)
Sets the indicator which determines if the task command needs to check the 'URL' parameter is not null and its length large than 0. Default is true.
Parameters:
abCheckURL - The indicator which determines if the task command needs to check the 'URL' parameter

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
sets the request properties need to be processed.
Parameters:
aRequestProperties - The request properties