com.ibm.commerce.foundation.client.facade.bod.servlet.struts

Class BusinessObjectDocumentActionMapping

  • java.lang.Object
    • org.apache.struts.config.ActionConfig
      • org.apache.struts.action.ActionMapping
        • com.ibm.commerce.foundation.client.facade.bod.servlet.struts.BusinessObjectDocumentActionMapping
  • All Implemented Interfaces:
    java.io.Serializable


    public class BusinessObjectDocumentActionMapping
    extends org.apache.struts.action.ActionMapping
    This action mapping class represents the action configuration of a BusinessObjectDocumentAction struts action. This class contains the configuration information to construct and execute a business object document. The action mapping must be associated with the BusinessObjectDocumentAction if the base implementation is used.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.util.Map getURLToContextParameters()
      This method returns the URL parameters that represent context parameters.
      java.lang.String getVar()
      This method returns the variable name to assign the list of nouns returned as a response of the business object document request.
      java.lang.String getVarException()
      This method returns the variable name to associate with the exception that is the result of the business object document request.
      java.lang.String getVarVerb()
      This method returns the variable name to associate with the response verb that is the responding business object document.
      java.lang.String getVerb()
      This method returns the verb to associate with the request.
      void mergeAliasParameters(java.util.Map request)
      This method merges the alias parameters if the input request contains any parameter defined as an alias.
      void mergeDefaultParameters(java.util.Map request)
      This method merges the default parameters to include with the transformation of the URL request to a business object document.
      void mergeDefaultResponseAttributeParameters(java.util.Map request)
      This method merges the default parameters to include with the transformation of the URL request to a business object document.
      void mergeDefaultResponseObjectParameters(java.util.Map request)
      This method merges the default parameters to include with the transformation of the URL request to a business object document.
      void setActionCode(java.lang.String actionCode)
      This method sets the action code of the verb in the business object document that is used with the URL request.
      void setAliasParameters(java.lang.String aliasParameters)
      This method sets the alias parameters that will create alias parameters if the parameter is found in the request.
      void setClientLibrary(java.lang.String clientLibrary)
      This method sets the client library class name that is used to execute the business object document.
      void setClientLibraryMethod(java.lang.String clientLibaryMethod)
      This method set the client library method used to execute the business object document.
      void setContextParameters(java.lang.String contextParameterList)
      This method sets the context data parameters to include in the business context of the request.
      void setDefaultParameters(java.lang.String defaultParameters)
      This method will set the default parameters to associate with the request.
      void setDefaultResponseAttributeParameters(java.lang.String defaultParameters)
      This method will set the default parameters to associate with the request.
      void setDefaultResponseObjectParameters(java.lang.String defaultParameters)
      This method will set the default parameters to associate with the request.
      void setDocumentRootFactory(java.lang.String documentRootFactory)
      This method sets the factory to use to create the document root.
      void setVar(java.lang.String var)
      This method sets the variable name to associate the nouns found in the responding business object document.
      void setVarException(java.lang.String varException)
      This method sets the variable name to associate with the exception that is the result of the business object document request.
      void setVarVerb(java.lang.String varVerb)
      This method sets the variable name to associate with the response verb that is the responding business object document.
      void setVerb(java.lang.String verb)
      This method sets the verb of the business object document that is used with the URL request.
      java.lang.String toString()
      This method returns the string representation of the object for debugging purposes.
      • Methods inherited from class org.apache.struts.action.ActionMapping

        findForward, findForwards, getInputForward
      • Methods inherited from class org.apache.struts.config.ActionConfig

        addExceptionConfig, addForwardConfig, findException, findExceptionConfig, findExceptionConfigs, findForwardConfig, findForwardConfigs, freeze, getAttribute, getCancellable, getForward, getInclude, getInput, getModuleConfig, getMultipartClass, getName, getParameter, getPath, getPrefix, getRoleNames, getRoles, getScope, getSuffix, getType, getUnknown, getValidate, removeExceptionConfig, removeForwardConfig, setAttribute, setCancellable, setForward, setInclude, setInput, setModuleConfig, setMultipartClass, setName, setParameter, setPath, setPrefix, setRoles, setScope, setSuffix, setType, setUnknown, setValidate
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • BusinessObjectDocumentActionMapping

        public BusinessObjectDocumentActionMapping()
        Creates an instance of the business object document action mapping.
    • Method Detail

      • getURLToContextParameters

        public java.util.Map getURLToContextParameters()
        This method returns the URL parameters that represent context parameters. The returned map returns an association between the URL parameter and the context name.
        Returns:
        An association of the URL parameters and context parameters that is used to populate the business context of the request.
      • mergeDefaultParameters

        public void mergeDefaultParameters(java.util.Map request)
        This method merges the default parameters to include with the transformation of the URL request to a business object document.
        Parameters:
        request - The request java.util.Map to merge the default parameters into.
      • mergeDefaultResponseObjectParameters

        public void mergeDefaultResponseObjectParameters(java.util.Map request)
        This method merges the default parameters to include with the transformation of the URL request to a business object document.
        Parameters:
        request - The request java.util.Map to merge the default parameters into.
      • mergeDefaultResponseAttributeParameters

        public void mergeDefaultResponseAttributeParameters(java.util.Map request)
        This method merges the default parameters to include with the transformation of the URL request to a business object document.
        Parameters:
        request - The request java.util.Map to merge the default parameters into.
      • mergeAliasParameters

        public void mergeAliasParameters(java.util.Map request)
        This method merges the alias parameters if the input request contains any parameter defined as an alias. The alias parameter will have the same value as the corresponding parameter in the request.
        Parameters:
        request - The request java.util.Map to merge the alias parameters names into.
      • getVerb

        public java.lang.String getVerb()
        This method returns the verb to associate with the request.
        Returns:
        The verb used to create the business object document.
      • setVerb

        public void setVerb(java.lang.String verb)
        This method sets the verb of the business object document that is used with the URL request.
        Parameters:
        verb - The verb of the business object document.
      • setActionCode

        public void setActionCode(java.lang.String actionCode)
        This method sets the action code of the verb in the business object document that is used with the URL request.
        Parameters:
        actionCode - The action code.
      • setClientLibrary

        public void setClientLibrary(java.lang.String clientLibrary)
        This method sets the client library class name that is used to execute the business object document.
        Parameters:
        clientLibrary - The client library class.
      • setClientLibraryMethod

        public void setClientLibraryMethod(java.lang.String clientLibaryMethod)
        This method set the client library method used to execute the business object document.
        Parameters:
        clientLibaryMethod - The method of the client library that will process the business object document.
      • setDocumentRootFactory

        public void setDocumentRootFactory(java.lang.String documentRootFactory)
        This method sets the factory to use to create the document root. When the document root factory is set, the class and createDocumentRoot() method is resolved.
        Parameters:
        documentRootFactory - The factory used to create the document root which is the parent container of the business object document.
      • setContextParameters

        public void setContextParameters(java.lang.String contextParameterList)
        This method sets the context data parameters to include in the business context of the request. The context parameter is a common separated list indicating the URL parameter name of the value to include in the business context. Each value of the list can be in the format of "URL Parameter:Context Name" which indicates the URL parameter value and the context name. For those values that does not contain :, it will be assumed that the url parameter is the context name.
        Parameters:
        contextParameterList - A common separated list containing the URL parameter mapping to context data parameter. These are the context data populated in the business context for the request.
      • setDefaultParameters

        public void setDefaultParameters(java.lang.String defaultParameters)
        This method will set the default parameters to associate with the request. These parameters is added to the request when converting the URL to the request business object document.
        Parameters:
        defaultParameters - A query string representing the parameters to include with the parameters that have been specified with the request.
      • setDefaultResponseObjectParameters

        public void setDefaultResponseObjectParameters(java.lang.String defaultParameters)
        This method will set the default parameters to associate with the request. These parameters is added to the request when converting the URL to the request business object document.
        Parameters:
        defaultParameters - A query string representing the parameters to include with the parameters that have been specified with the request.
      • setDefaultResponseAttributeParameters

        public void setDefaultResponseAttributeParameters(java.lang.String defaultParameters)
        This method will set the default parameters to associate with the request. These parameters is added to the request when converting the URL to the request business object document.
        Parameters:
        defaultParameters - A query string representing the parameters to include with the parameters that have been specified with the request.
      • setAliasParameters

        public void setAliasParameters(java.lang.String aliasParameters)
        This method sets the alias parameters that will create alias parameters if the parameter is found in the request.
        Parameters:
        aliasParameters - The alias parameters.
      • toString

        public java.lang.String toString()
        This method returns the string representation of the object for debugging purposes.
        Overrides:
        toString in class org.apache.struts.config.ActionConfig
        Returns:
        The string representation of the object.
      • getVar

        public java.lang.String getVar()
        This method returns the variable name to assign the list of nouns returned as a response of the business object document request.
        Returns:
        The variable name to associate with the list of nouns that is returned in the business object document response.
      • setVar

        public void setVar(java.lang.String var)
        This method sets the variable name to associate the nouns found in the responding business object document.
        Parameters:
        var - The variable name to associate with the list of nouns that is returned in the business object document response.
      • getVarException

        public java.lang.String getVarException()
        This method returns the variable name to associate with the exception that is the result of the business object document request.
        Returns:
        The variable name to associate with the exception that is the result of the business object document request.
      • setVarException

        public void setVarException(java.lang.String varException)
        This method sets the variable name to associate with the exception that is the result of the business object document request.
        Parameters:
        varException - The variable name to associate with the exception that is the result of the business object document request.
      • getVarVerb

        public java.lang.String getVarVerb()
        This method returns the variable name to associate with the response verb that is the responding business object document.
        Returns:
        The variable name to associate with the response verb that is the responding business object document.
      • setVarVerb

        public void setVarVerb(java.lang.String varVerb)
        This method sets the variable name to associate with the response verb that is the responding business object document.
        Parameters:
        varVerb - The variable name to associate with the response verb that is the responding business object document.