public class BusinessObjectDocumentActionMapping
extends org.apache.struts.action.ActionMapping
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.Constructor and Description |
---|
BusinessObjectDocumentActionMapping()
Creates an instance of the business object document action mapping.
|
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.
|
findForward, findForwards, getInputForward
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
public BusinessObjectDocumentActionMapping()
public java.util.Map getURLToContextParameters()
public void mergeDefaultParameters(java.util.Map request)
request
- The request java.util.Map
to merge the default
parameters into.public void mergeDefaultResponseObjectParameters(java.util.Map request)
request
- The request java.util.Map
to merge the default
parameters into.public void mergeDefaultResponseAttributeParameters(java.util.Map request)
request
- The request java.util.Map
to merge the default
parameters into.public void mergeAliasParameters(java.util.Map request)
request
- The request java.util.Map
to merge the alias
parameters names into.public java.lang.String getVerb()
public void setVerb(java.lang.String verb)
verb
- The verb of the business object document.public void setActionCode(java.lang.String actionCode)
actionCode
- The action code.public void setClientLibrary(java.lang.String clientLibrary)
clientLibrary
- The client library class.public void setClientLibraryMethod(java.lang.String clientLibaryMethod)
clientLibaryMethod
- The method of the client library that will process
the business object document.public void setDocumentRootFactory(java.lang.String documentRootFactory)
createDocumentRoot()
method is resolved.documentRootFactory
- The factory used to create the document root which is the
parent container of the business object document.public void setContextParameters(java.lang.String contextParameterList)
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.public void setDefaultParameters(java.lang.String defaultParameters)
defaultParameters
- A query string representing the parameters to include
with the parameters that have been specified with the request.public void setDefaultResponseObjectParameters(java.lang.String defaultParameters)
defaultParameters
- A query string representing the parameters to include
with the parameters that have been specified with the request.public void setDefaultResponseAttributeParameters(java.lang.String defaultParameters)
defaultParameters
- A query string representing the parameters to include
with the parameters that have been specified with the request.public void setAliasParameters(java.lang.String aliasParameters)
aliasParameters
- The alias parameters.public java.lang.String toString()
toString
in class org.apache.struts.config.ActionConfig
public java.lang.String getVar()
public void setVar(java.lang.String var)
var
- The variable name to associate with the list of nouns that is returned
in the business object document response.public java.lang.String getVarException()
public void setVarException(java.lang.String varException)
varException
- The variable name to associate with the exception that is the result of
the business object document request.public java.lang.String getVarVerb()
public void setVarVerb(java.lang.String varVerb)
varVerb
- The variable name to associate with the response verb that is the responding
business object document.