com.ibm.commerce.command

Interface ViewCommandContext

  • All Superinterfaces:
    java.lang.Cloneable, CommandContext


    public interface ViewCommandContext
    extends CommandContext
    This interface defines the view command context. It contains request information. It is used by the view commands and JSPs to retrieve context information. associated with a request.
    • Field Detail

      • COPYRIGHT

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

      • getEncoding

        java.lang.String getEncoding()
        This method gets the character encoding.
        Specified by:
        getEncoding in interface CommandContext
        Returns:
        This method returns the character encoding.
      • getRequest

        java.lang.Object getRequest()
        This method gets the controller request object associated with this request.
        Specified by:
        getRequest in interface CommandContext
        Returns:
        his method returns the request object.
      • getResolvedQueryString

        java.lang.String getResolvedQueryString()
        This method gets the resolved request properties as a queryString.
        Specified by:
        getResolvedQueryString in interface CommandContext
        Returns:
        his method returns the resolved query string.
      • getResolvedEncodedQueryString

        java.lang.String getResolvedEncodedQueryString()
        This method gets the resolved request properties as a queryString.
        Returns:
        his method returns the resolved query string. The names and values are encoded.
      • getResponse

        java.lang.Object getResponse()
        This method gets the response object associated with this request.
        Specified by:
        getResponse in interface CommandContext
        Returns:
        his method returns the response object.
      • getUniqueSessionTag

        java.lang.String getUniqueSessionTag()
        This method gets a tag that is unique for the session. Reserved for IBM internal use.
        Specified by:
        getUniqueSessionTag in interface CommandContext
        Returns:
        his method returns the unique session tag.
      • setRequest

        void setRequest(java.lang.Object value)
        This method sets the controller request object associated with this command. Reserved for IBM internal use.
        Specified by:
        setRequest in interface CommandContext
        Parameters:
        value - This is the request object.
      • setResponse

        void setResponse(java.lang.Object value)
        This method sets the response object associated with this command. Reserved for IBM internal use.
        Specified by:
        setResponse in interface CommandContext
        Parameters:
        value - This is the response object.
      • getWebpath

        java.lang.String getWebpath()
        This method gets the web path for an HTTP request. Reserved for IBM internal use.
        Specified by:
        getWebpath in interface CommandContext
        Returns:
        his method returns the web path.
      • setWebpath

        void setWebpath(java.lang.String webpath)
        This method sets the web path associated with this command. Reserved for IBM internal use.
        Specified by:
        setWebpath in interface CommandContext
        Parameters:
        webpath - This is the web path.
      • isStoreCommand

        boolean isStoreCommand()
        This method determines whether this is a store command. It returns true if it is and false otherwise. If it is, it implies that the store directory will be automatically added to the document path for any forward view command. Reserved for IBM internal use.
        Specified by:
        isStoreCommand in interface CommandContext
        Returns:
        This method returns true if this is a store command and false otherwise.
      • setEncoding

        void setEncoding(java.lang.String encoding)
        This method sets the character encoding. Reserved for IBM internal use.
        Specified by:
        setEncoding in interface CommandContext
        Parameters:
        encoding - This is the character encoding to set.
      • setStoreCommand

        void setStoreCommand(boolean value)
        This method determines whether this is a store level command. It returns true if this is a store level command and false otherwise. Reserved for IBM internal use.
        Specified by:
        setStoreCommand in interface CommandContext
        Parameters:
        value - This is a boolean value; true if this is a store level command and false otherwise.