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

Class CSRReturnBaseCmdImpl

    • Field Detail

      • COPYRIGHT

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

        public static final java.lang.String ERRTASK_NAME
        Default redirect URL when errors are encountered.
        See Also:
        Constant Field Values
    • Constructor Detail

      • CSRReturnBaseCmdImpl

        public CSRReturnBaseCmdImpl()
        Constructor for CSRReturnBaseCmdImpl.
    • Method Detail

      • getCustomerId

        public java.lang.String getCustomerId()
        Gets customer identifier which is used to set the forUserId parameter in the request property when calling a command.
        Returns:
        customer identifier
      • getNLS

        public java.util.Hashtable getNLS()
        Gets reference to property file used for Returns user interface.
        Returns:
        reference to the contents of the property file
      • getOrigCmdContext

        public CommandContext getOrigCmdContext()
        Gets command context as it was at the start of command run.
        Returns:
        original command context
      • getOrigReqProperties

        public TypedProperty getOrigReqProperties()
        Gets request property as it was at the start of command run.
        Returns:
        original request properties
      • getRedirectURL

        public java.lang.String getRedirectURL()
        Gets redirect url. The redirect URL is passed in as a parameter to all the CSR Returns commands..
        Returns:
        redirect URL
      • getReturnId

        public java.lang.String getReturnId()
        Gets the unique identifier of the Return being processed.
        Returns:
        return identifier
      • setCustomerId

        public void setCustomerId(java.lang.String newCustomerId)
        Sets the unique identifier of the customer whom owns the Return being processed.
        Parameters:
        newCustomerId - customer identifier
      • setOrigCmdContext

        public void setOrigCmdContext(CommandContext newOrigCmdContext)
        Saves a copy of the command context at the start of command run.
        Parameters:
        newOrigCmdContext - command context
      • setOrigReqProperties

        public void setOrigReqProperties(TypedProperty newOrigReqProperties)
        Saves a copy of the request properties at the start of command run.
        Parameters:
        newOrigReqProperties - request properties
      • setRedirectURL

        public void setRedirectURL(java.lang.String newRedirectURL)
        Sets the redirect URL.
        Parameters:
        newRedirectURL - URL to which to redirect when command terminates
      • setReturnId

        public void setReturnId(java.lang.String newReturnId)
        Sets unique identifier of the Return being processed.
        Parameters:
        newReturnId - Return identifier
      • traceFormat

        public java.lang.String traceFormat(TypedProperty prop)
        Formats a trace message. Converts to a string, and removes tabs and new lines markers.
        Parameters:
        prop - message to be formatted