com.ibm.commerce.beans

Class ControllerCommandInvokerDataBean

java.lang.Object

com.ibm.commerce.beans.InputDataBeanImpl

com.ibm.commerce.beans.SmartDataBeanImpl

com.ibm.commerce.beans.ControllerCommandInvokerDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, java.io.Serializable

public class ControllerCommandInvokerDataBean
extends SmartDataBeanImpl

This data bean is a SmartDataBean object that allows a JSP to invoke a controller command. It extends the SmartDataBeanImpl class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.

Fields inherited from interface com.ibm.commerce.beans.DataBean

emptyString

Constructor Summary

Constructors

Constructor and Description
ControllerCommandInvokerDataBean()

Method Summary

Modifier and Type	Method and Description
void	executeErrorView() Deprecated. Replaced by executeErrorView(HttpServletResponse)
void	executeErrorView(javax.servlet.http.HttpServletResponse response) This method executes the error view when an exception is thrown.
void	executeView() Deprecated. Replaced by executeView(HttpServletResponse)
void	executeView(javax.servlet.http.HttpServletResponse response) This method executes the view associated with the controller command.
java.lang.String	getCommandInterfaceName() This method gets the command interface name.
java.lang.String	getCommandName() This method gets the command name, namely the URL name.
TypedProperty	getErrorProperties() This method gets the response properties after the error view has been executed.
TypedProperty	getResponseProperties() This method gets the response properties associated with the command.
void	populate() This method populates the command data bean.
void	setCommandInterfaceName(java.lang.String astrInterfaceName) This method sets the command interface name
void	setCommandName(java.lang.String astrCommandName) This method sets the url command name.
void	setErrorProperties(TypedProperty aProperties) This method sets the error response properties.
void	setResponseProperties(TypedProperty aRespProperties) This method sets the response properties.

Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext

Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

getRequestProperties, setRequestProperties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.beans.InputDataBean

getRequestProperties, setRequestProperties

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

Constructor Detail

ControllerCommandInvokerDataBean

public ControllerCommandInvokerDataBean()

Method Detail

executeErrorView

public void executeErrorView()
                      throws java.lang.Exception

Deprecated. Replaced by executeErrorView(HttpServletResponse)

This method executes the error view when an exception is thrown.

Throws:

java.lang.Exception - This is thrown if there is a problem executing the error view or with handling the transaction of calling the error view.

executeErrorView

public void executeErrorView(javax.servlet.http.HttpServletResponse response)
                      throws java.lang.Exception

This method executes the error view when an exception is thrown.

Parameters:

response - This is an HttpServletResponse object.

Throws:

java.lang.Exception - This is thrown if there is a problem executing the error view or with handling the transaction of calling the error view.

executeView

public void executeView()
                 throws java.lang.Exception

Deprecated. Replaced by executeView(HttpServletResponse)

This method executes the view associated with the controller command.

Throws:

java.lang.Exception - This is thrown if there is a problem executing the view or with handling the transaction of calling the view.

executeView

public void executeView(javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception

This method executes the view associated with the controller command.

Parameters:

response - This is an HttpServletResponse object.

Throws:

java.lang.Exception - This is thrown if there is a problem executing the view or with handling the transaction of calling the view.

getCommandInterfaceName

public java.lang.String getCommandInterfaceName()

This method gets the command interface name.

Returns:

The interface name of the command.

getCommandName

public java.lang.String getCommandName()

This method gets the command name, namely the URL name.

Returns:

This method returns the name of the url command.

getErrorProperties

public TypedProperty getErrorProperties()

This method gets the response properties after the error view has been executed.

Returns:

This method returns the response properties after executing the error view.

getResponseProperties

public TypedProperty getResponseProperties()

This method gets the response properties associated with the command.

Returns:

This method returns the response properties associated with the command.

populate

public void populate()
              throws java.lang.Exception

This method populates the command data bean. This includes instantiating the command, setting the command context and request properties, and then executing the command.

Specified by:

populate in interface SmartDataBean

Overrides:

populate in class SmartDataBeanImpl

Throws:

java.lang.Exception - This is thrown if there is a problem executing the command or retrieving the properties after the command is executed.

setCommandInterfaceName

public void setCommandInterfaceName(java.lang.String astrInterfaceName)

This method sets the command interface name

Parameters:

astrInterfaceName - This is the name of the interface.

setCommandName

public void setCommandName(java.lang.String astrCommandName)

This method sets the url command name.

Parameters:

astrCommandName - This is the name of the url command.

setErrorProperties

public void setErrorProperties(TypedProperty aProperties)

This method sets the error response properties.

Parameters:

aProperties - This is an object that represents the error response properties.

setResponseProperties

public void setResponseProperties(TypedProperty aRespProperties)

This method sets the response properties.

Parameters:

aRespProperties - This is an object that represents the response properties.