com.ibm.commerce.usermanagement.commands

Interface ProcessRequestPropertiesCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, 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 the 'XML' parameter, it assumes that the URL command is called in the tools framework. Otherwise it assumes the URL command is directly called from a URL.
    If called from the 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 and sets '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 is larger than 0.
   default is true.

    • Field Detail

      • COPYRIGHT

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

      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation of this command.
        See Also:
        Constant Field Values

    • Method Detail

      • getCheckURL

        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

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

      • getResponseProperties

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

      • getXMLFile

        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

        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

        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

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