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, java.io.Serializable, SmartDataBean

public class ControllerCommandInvokerDataBean
extends SmartDataBeanImpl

This is a smart data bean that allows a JSP page to invoke a controller command.

See Also:
Serialized Form

Field Summary
protected ControllerCommand command
The controller command to be invoked.
static java.lang.String COPYRIGHT
IBM Copyright notice field.
Fields inherited from class com.ibm.commerce.beans.SmartDataBeanImpl
commandContext
Fields inherited from class com.ibm.commerce.beans.InputDataBeanImpl
requestProperties
Fields inherited from interface com.ibm.commerce.beans.DataBean
emptyString
Constructor Summary
ControllerCommandInvokerDataBean()
Method Summary
void executeErrorView()
Deprecated. Replaced by executeErrorView(HttpServletResponse)
void executeErrorView(HttpServletResponse response)
Execute the error view when an exception was thrown.
void executeView()
Deprecated. Replaced by executeView(HttpServletResponse)
void executeView(HttpServletResponse response)
Execute the view associated with the controller command.
java.lang.String getCommandInterfaceName()
Gets the command interface name.
java.lang.String getCommandName()
Gets the command name i.e the URL name.
TypedProperty getErrorProperties()
Get the response properties after the error view has been executed.
TypedProperty getResponseProperties()
Get the response properties associated with command.
void populate()
Populate the command bean.
void setCommandInterfaceName(java.lang.String astrInterfaceName)
Sets the command interface name
void setCommandName(java.lang.String astrCommandName)
Sets the url command name.
void setErrorProperties(TypedProperty aProperties)
Sets the error properties.
void setResponseProperties(TypedProperty aRespProperties)
Sets the response properties.
Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl
fulfills, getCommandContext, getResources, setCommandContext
Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl
getRequestProperties, setRequestProperties
Methods inherited from class java.lang.Object
clone, equals, finalize, 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

command

protected ControllerCommand command
The controller command to be invoked.
Constructor Detail

ControllerCommandInvokerDataBean

public ControllerCommandInvokerDataBean()
Method Detail

executeErrorView

public void executeErrorView()
                      throws java.lang.Exception
Deprecated. Replaced by executeErrorView(HttpServletResponse)
Execute the error view when an exception was thrown.
Throws:
java.lang.Exception - if there was a problem executing the error view or with handling the transaction of calling the error view.

executeErrorView

public void executeErrorView(HttpServletResponse response)
                      throws java.lang.Exception
Execute the error view when an exception was thrown.
Parameters:
response - The http servlet response object
Throws:
java.lang.Exception - if there was 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)
Execute the view associated with the controller command.
Throws:
java.lang.Exception - if there was a problem executing the view or with handling the transaction of calling the view.

executeView

public void executeView(HttpServletResponse response)
                 throws java.lang.Exception
Execute the view associated with the controller command.
Parameters:
response - HttpServletResponse object
Throws:
java.lang.Exception - if there was a problem executing the view or with handling the transaction of calling the view.

getCommandInterfaceName

public java.lang.String getCommandInterfaceName()
Gets the command interface name.
Returns:
The interface name of the command.

getCommandName

public java.lang.String getCommandName()
Gets the command name i.e the URL name.
Returns:
The name of the url command.

getErrorProperties

public TypedProperty getErrorProperties()
Get the response properties after the error view has been executed.
Returns:
the response properties after executing the error view.

getResponseProperties

public TypedProperty getResponseProperties()
Get the response properties associated with command.
Returns:
the response properties of the command.

populate

public void populate()
              throws java.lang.Exception
Populate the command bean. This includes instantiating the command and 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 - if there is a problem executing the command and retrieving the properties after the comand is executed.

setCommandInterfaceName

public void setCommandInterfaceName(java.lang.String astrInterfaceName)
Sets the command interface name

setCommandName

public void setCommandName(java.lang.String astrCommandName)
Sets the url command name.

setErrorProperties

public void setErrorProperties(TypedProperty aProperties)
Sets the error properties.

setResponseProperties

public void setResponseProperties(TypedProperty aRespProperties)
Sets the response properties.

Feedback