com.iplanet.jato.view
Class RequestHandlingTiledViewBase

java.lang.Object
  |
  +--com.iplanet.jato.view.ViewBase
        |
        +--com.iplanet.jato.view.ContainerViewBase
              |
              +--com.iplanet.jato.view.TiledViewBase
                    |
                    +--com.iplanet.jato.view.RequestHandlingTiledViewBase
All Implemented Interfaces:
ContainerView, RequestHandler, RequestParticipant, TiledView, View, WebActionHandler, WebActions

public abstract class RequestHandlingTiledViewBase
extends TiledViewBase
implements RequestHandler, WebActionHandler

An intermediate TiledView derivation that supports request handling and handling of web actions. It is a separate class to support potentially several subclasses that wish to take advantage of this behavior but may differ in other significant ways.

Version:
JATO/1.2.2 $Id: RequestHandlingTiledViewBase.java,v 1.37 2002/04/04 12:52:08 todd Exp $

Field Summary
static java.lang.String HANDLE_REQUEST_METHOD_PREFIX
           
static java.lang.String HANDLE_REQUEST_METHOD_SUFFIX
           
 
Fields inherited from class com.iplanet.jato.view.TiledViewBase
UNDEFINED_ROW_INDEX
 
Fields inherited from class com.iplanet.jato.view.ContainerViewBase
BEGIN_DISPLAY_EVENT_METHOD_PREFIX, BEGIN_DISPLAY_EVENT_METHOD_SUFFIX, END_DISPLAY_EVENT_METHOD_PREFIX, END_DISPLAY_EVENT_METHOD_SUFFIX, eventMethodRegistry, OPTION_ENABLE_QUALIFIELD_CHILD_NAME_LOOKUPS, OPTION_USE_LEGACY_DISPLAY_EVENT_SIGNATURES
 
Fields inherited from interface com.iplanet.jato.view.WebActionHandler
DELETE_CONTEXT, EXECUTE_CONTEXT, INSERT_CONTEXT, MODEL_TYPE_DELETE, MODEL_TYPE_EXECUTE, MODEL_TYPE_INSERT, MODEL_TYPE_RETRIEVE, MODEL_TYPE_UPDATE, RETRIEVE_CONTEXT, UPDATE_CONTEXT
 
Fields inherited from interface com.iplanet.jato.view.WebActions
ACTION_CLEAR, ACTION_DELETE, ACTION_EXECUTE, ACTION_FIRST, ACTION_INSERT, ACTION_LAST, ACTION_NEXT, ACTION_PREV, ACTION_PREVIOUS, ACTION_REFRESH, ACTION_SELECT, ACTION_UPDATE
 
Fields inherited from interface com.iplanet.jato.view.View
QUALIFIED_VIEW_NAME_SEPARATOR
 
Constructor Summary
RequestHandlingTiledViewBase(View parent, java.lang.String name)
          Creates an instance with a parent and name
 
Method Summary
 java.lang.Object acceptRequest(javax.servlet.http.HttpServletRequest request)
          This method is used by the application servlet to determine if this is the appropriate view to handle the servlet request.
 void afterAllModelsExecute(int executionContext)
          Invoked as notification that all auto-executing models have been executed.
 void afterModelExecutes(Model model, int executionContext)
          Invoked as notification that a given model has been auto-executed.
 void appMessage(java.lang.String message)
          Convenience method to make obtaining the MessageWriter instance from the RequestContext easier.
 boolean beforeModelExecutes(Model model, int executionContext)
          Invoked as notification that a given model is about to be auto-executed.
 void beginDisplay(DisplayEvent event)
          Called as notification that the JSP has begun its display processing.
protected  DatasetModelExecutionContext createDefaultExecutionContext()
          Creates and returns an execution used for auto-retrieval.
 java.lang.Object executeAutoDeletingModel(ModelExecutionContext context, Model m)
          Executes the specified deleting model.
 void executeAutoDeletingModels(ModelExecutionContext context)
          Executes all of this view's deleting models.
 java.lang.Object executeAutoExecutingModel(ModelExecutionContext context, Model m)
          Executes the specified executing model.
 void executeAutoExecutingModels(ModelExecutionContext context)
          Executes all of this view's executing models.
 java.lang.Object executeAutoInsertingModel(ModelExecutionContext context, Model m)
          Executes the specified inserting model.
 void executeAutoInsertingModels(ModelExecutionContext context)
          Executes all of this view's inserting models.
 java.lang.Object executeAutoRetrievingModel(DatasetModelExecutionContext context, Model m)
          Executes the specified retrieving model.
 void executeAutoRetrievingModels()
          Executes all of this view's auto-retrieving models.
 void executeAutoRetrievingModels(DatasetModelExecutionContext context)
          Executes all of this view's auto-retrieving models.
 java.lang.Object executeAutoUpdatingModel(ModelExecutionContext context, Model m)
          Executes the specified updating model.
 void executeAutoUpdatingModels(ModelExecutionContext context)
          Executes all of this view's updating models.
protected  DatasetModelExecutionContext getAutoRetrieveExecutionContext()
          Returns the current auto-retrieval execution context, if present.
 DatasetModelExecutionContext getFirstActionExecutionContext()
          Returns an execution context suitable to the first web action.
 DatasetModelExecutionContext getLastActionExecutionContext()
          Returns an execution context suitable to the last web action.
 Model getModel(java.lang.Class clazz)
          Convenience method to make obtaining a model instance by its default name from the ModelManager easier.
 DatasetModelExecutionContext getNextActionExecutionContext()
          Returns an execution context suitable to the next web action.
 DatasetModelExecutionContext getPreviousActionExecutionContext()
          Returns an execution context suitable to the previous web action.
 DatasetModel getPrimaryModel()
          Returns the primary model used by this model's iteration and navigation logic.
 java.lang.Class getPrimaryModelClass()
          Returns the primary model class if one has been previously set, or if the primary model instance has been set.
 DatasetModelExecutionContext getRefreshActionExecutionContext()
          Returns an execution context suitable to the refresh web action.
 java.lang.String[] getRequestCompletionListenerChildNames()
          Returns the names of registered children that are of type RequestParticipant.
 RequestContext getRequestContext()
          Returns the current request context.
 java.lang.String[] getRequestParticipantChildNames()
          Returns the names of registered children that are of type RequestParticipant.
 javax.servlet.http.HttpSession getSession()
          Convenience method to make obtaining the HttpSession instance from the RequestContext easier.
 ViewBean getViewBean(java.lang.Class clazz)
          Convenience method to make obtaining a view bean instance from the ViewBeanManager easier.
protected  java.lang.String getWebActionMaxDisplayRowsSessionKey()
          Returns the session attribute key used to store the max display tiles of this view for the user.
protected  int getWebActionModelMaxDisplayTiles()
          Returns the value for the maximum number of tiles to display
protected  int getWebActionModelOffset()
          Gets the offset into the result set of the DatasetModel involved in the current WebAction.
 Model[] getWebActionModels(int executionType)
          Return the web action models associated with this view by execution type.
protected  java.lang.String getWebActionRowOffsetSessionKey()
          Returns the session attribute key used to store the row offset of this view for the user.
 void handleRequest(java.lang.Object anInvocation)
          Called by the application servlet to have the request handler process this request.
 void handleWebAction(int actionType)
          Performs the specified standard web action.
 boolean isAutoRetrieveEnabled()
          Returns the state of auto-retrieval.
 void onModelError(Model model, int executionContext, ModelControlException exception)
          Invoked as notification that a given model threw a ModelControlException during auto-execution.
 void onNoModelDataAvailable(Model model, int executionContext)
          Deprecated. This method is no longer supported
 void requestComplete()
          Called upon notification that the current request is complete.
 void setAutoRetrieveEnabled(boolean autoRetrieveEnabled)
          Sets the state of auto-retrieval for this request.
protected  void setAutoRetrieveExecutionContext(DatasetModelExecutionContext value)
          Sets the current auto-retrieval execution context.
 void setPrimaryModel(DatasetModel value)
          Sets the primary model used by this model's iteration and navigation logic.
 void setPrimaryModelClass(java.lang.Class value)
          Sets the class of the primary model, in order to allow later instantiation of the necessary primary model.
 void setPrimaryModelClass(java.lang.Class value, boolean lookInSession, boolean saveInSession)
          Sets the class of the primary model, in order to allow later instantiation of the necessary primary model.
 void setRequestContext(RequestContext value)
          Sets the request context
protected  void setWebActionModelMaxDisplayTiles(int value)
          Sets the value for the maximum number of tiles to display
protected  void setWebActionModelOffset(int value)
          Sets the offset into the result set of the DatasetModel involved in the current WebAction.
 
Methods inherited from class com.iplanet.jato.view.TiledViewBase
dumpChildValues, dumpChildValues, getChild, getChildValues, getDisplayIndex, getMaxDisplayTiles, getNonIndexedQualifiedName, getNumTiles, getQualifiedName, getTileIndex, incrementDisplayIndex, isTileDisplayable, mapRequestParameters, nextTile, nextTileInternal, resetDisplayIndex, resetTileIndex, setDisplayIndex, setMaxDisplayTiles, setPrimaryModel, setTileIndex
 
Methods inherited from class com.iplanet.jato.view.ContainerViewBase
beginChildDisplay, beginChildDisplay, beginDisplay, childExists, createChild, createChildInternal, endChildDisplay, endChildDisplay, endDisplay, endDisplay, ensureChild, getChild, getChildNames, getChildNames, getChildType, getCommandChildNames, getDefaultModel, getDisplayField, getDisplayFieldBooleanValue, getDisplayFieldDoubleValue, getDisplayFieldIntValue, getDisplayFieldStringValue, getDisplayFieldValue, getNumChildren, getQualifiedCommandChildNames, mapRequestParameter, onValidationException, registerChild, registerDisplayEventHandlers, removeAllChildren, removeChild, removeQualifiedNameIndices, resetChildren, setDefaultModel, setDisplayFieldValue, setDisplayFieldValue, setDisplayFieldValue, setDisplayFieldValue, unregisterChild
 
Methods inherited from class com.iplanet.jato.view.ViewBase
getName, getParent, getParentViewBean, getRootView, getRootView, setName, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.iplanet.jato.view.ContainerView
beginChildDisplay, endChildDisplay, endDisplay, getChild, getChildNames, getChildType, getDefaultModel, getDisplayField, getDisplayFieldValue, getNumChildren, resetChildren, setDisplayFieldValue
 
Methods inherited from interface com.iplanet.jato.view.View
getName, getParent, setParent
 

Field Detail

HANDLE_REQUEST_METHOD_PREFIX

public static final java.lang.String HANDLE_REQUEST_METHOD_PREFIX

HANDLE_REQUEST_METHOD_SUFFIX

public static final java.lang.String HANDLE_REQUEST_METHOD_SUFFIX
Constructor Detail

RequestHandlingTiledViewBase

public RequestHandlingTiledViewBase(View parent,
                                    java.lang.String name)
Creates an instance with a parent and name
Parameters:
parent - The parent view or null if this view has no parent
name - The logical name of this view
Method Detail

getPrimaryModel

public DatasetModel getPrimaryModel()
Returns the primary model used by this model's iteration and navigation logic. The primary model is the only model used by this logic, regardless of the models bound to child views. Child views must be bound to the primary model to experience the effect of tile iteration. The primary model must be specified before iteration through this view's tiles can occur.

Additionally, if a primary model has not already been set on this view, this method will attempt to create a primary model if the primary model class has been provided.

Overrides:
getPrimaryModel in class TiledViewBase
Returns:
This view's primary model, used for iteration through tiles

setPrimaryModel

public void setPrimaryModel(DatasetModel value)
Sets the primary model used by this model's iteration and navigation logic. The primary model is the only model used by this logic, regardless of the models bound to child views. Child views must be bound to the primary model to experience the effect of tile iteration. The primary model must be specified before iteration through this view's tiles can occur. This method will also set the value of the primary model class property.
Overrides:
setPrimaryModel in class TiledViewBase
Parameters:
value - This view's primary model, used for iteration through tiles
See Also:
DatasetModel

getPrimaryModelClass

public java.lang.Class getPrimaryModelClass()
Returns the primary model class if one has been previously set, or if the primary model instance has been set. Because of certain constraints in obtaining a model instance at view construction time (such as the request context not yet being present), a developer can optionally set the primary model class instead of the primary model instance. This allows the view to later instantiate the primary model object using the request context's model manager. In general, we recommend that developers set the primary model class rather than a primary model instance during initialization of a tiled view.
Returns:
The primary model class, or null if a primary model class has not been set

setPrimaryModelClass

public void setPrimaryModelClass(java.lang.Class value)
Sets the class of the primary model, in order to allow later instantiation of the necessary primary model. Because of certain constraints in obtaining a model instance at view construction time (such as the request context not yet being present), a developer can optionally set the primary model class instead of the primary model instance. This allows the view to later instantiate the primary model object using the request context's ModelManager. In general, we recommend that developers set the primary model class rather than a primary model instance during initialization of a tiled view. The primary model class must implement the com.iplanet.jato.model.DatasetModel interface.
Parameters:
The - primary model class

setPrimaryModelClass

public void setPrimaryModelClass(java.lang.Class value,
                                 boolean lookInSession,
                                 boolean saveInSession)
Sets the class of the primary model, in order to allow later instantiation of the necessary primary model. Because of certain constraints in obtaining a model instance at view construction time (such as the request context not yet being present), a developer can optionally set the primary model class instead of the primary model instance. This allows the view to later instantiate the primary model object using the request context's model manager. In general, we recommend that developers set the primary model class rather than a primary model instance during initialization of a tiled view. The primary model class must implement the com.iplanet.jato.model.DatasetModel interface.
Parameters:
The - primary model class

getRequestParticipantChildNames

public java.lang.String[] getRequestParticipantChildNames()
Returns the names of registered children that are of type RequestParticipant.
See Also:
RequestParticipant

getRequestCompletionListenerChildNames

public java.lang.String[] getRequestCompletionListenerChildNames()
Returns the names of registered children that are of type RequestParticipant.
See Also:
RequestCompletionListener

getRequestContext

public RequestContext getRequestContext()
Returns the current request context. We've augmented this method to search through any parent views for a request context. This is essentially to lessen the burden on the setting of the request context throughout all sub-views.
Specified by:
getRequestContext in interface RequestHandler
Returns:
The request context. Parent views will be searched recursively if the request context has not been set on this instance.

setRequestContext

public void setRequestContext(RequestContext value)
Description copied from interface: RequestParticipant
Sets the request context
Specified by:
setRequestContext in interface RequestParticipant
Following copied from interface: com.iplanet.jato.RequestParticipant
Parameters:
requestContext - The request context of the current request

requestComplete

public void requestComplete()
Called upon notification that the current request is complete. We've augmented this method to push this notification to any child views that are of type RequestCompletionListener.

acceptRequest

public java.lang.Object acceptRequest(javax.servlet.http.HttpServletRequest request)
Description copied from interface: RequestHandler
This method is used by the application servlet to determine if this is the appropriate view to handle the servlet request. The view should determine if one of its CommandField display fields generated this request, and return an invocation object describing the invocation.
Specified by:
acceptRequest in interface RequestHandler
Returns:
An opaque invocation object storing information necessary to the handleRequest() method of this implementation. This implementation currently returns an instance of TiledViewInvocation.

handleRequest

public void handleRequest(java.lang.Object anInvocation)
                   throws java.lang.Exception
Called by the application servlet to have the request handler process this request. This implementation will further dispatch the request to the Command specified in the invocation. If a command is not available from the invocation, a default command will be used to handle the request (an instance of DefaultTiledRequestHandlingCommand ).

There is no need to override this method in implementing classes, though of course, there is no reason one could not. Such a technique may be well suited to single-location security handling, logging, or other tasks.

The expected behavior of the handling method (or this method, if totally overridden) is to forward the request to another JSP/view bean/resource, preparing the target in any way necessary to support the request. Note that the current request context has already been set when this method is called by virtue of the RequestParticipant interface, which this class implements.

Specified by:
handleRequest in interface RequestHandler
Parameters:
invocation - The opaque invocation object previously returned by the acceptRequest(...) method. The implementation can store any information useful to it in this object. This implementation currently expects this object to be an instance of TiledViewInvocation.
See Also:
Command, DefaultRequestHandlingCommand, com.iplanet.jato.view.command.DefaultTieldRequestHandlingCommand

beginDisplay

public void beginDisplay(DisplayEvent event)
                  throws ModelControlException
Called as notification that the JSP has begun its display processing. In addition to performing the default behavior in the superclass's version, this method executes any auto-retrieving or auto- executing models associated with this view unless auto-retrieval is disabled.
Overrides:
beginDisplay in class ContainerViewBase
Parameters:
event - The DisplayEvent.
Throws:
ModelControlException - Thrown if manipulation of a model fails during display preparation or execution of auto-retrieving models

beforeModelExecutes

public boolean beforeModelExecutes(Model model,
                                   int executionContext)
Invoked as notification that a given model is about to be auto-executed. This method is only called during web action handling. The reason this and similar methods exist is to provide the developer a chance to perform application logic upon auto-execution, where they have no other opportunity to do so because the invocation of auto-executing models is under the control of the framework.
Parameters:
model - The model that is about to be auto-executed
executionContext - The context under which this model is being executed, one of WebActionHandler.RETRIEVE_CONTEXT, WebActionHandler.UPDATE_CONTEXT, WebActionHandler.DELETE_CONTEXT, WebActionHandler.INSERT_CONTEXT, or WebActionHandler.EXECUTE_CONTEXT
Returns:
True if the execution of the model should proceed, false to skip execution of the model
See Also:
WebActionHandler

afterModelExecutes

public void afterModelExecutes(Model model,
                               int executionContext)
Invoked as notification that a given model has been auto-executed. This method is only called during web action handling. The reason this and similar methods exist is to provide the developer a chance to perform application logic upon auto-execution, where they have no other opportunity to do so because the invocation of auto-executing models is under the control of the framework.
Parameters:
model - The model that has been auto-executed
executionContext - The context under which this model is being executed, one of WebActionHandler.RETRIEVE_CONTEXT, WebActionHandler.UPDATE_CONTEXT, WebActionHandler.DELETE_CONTEXT, WebActionHandler.INSERT_CONTEXT, or WebActionHandler.EXECUTE_CONTEXT
See Also:
WebActionHandler

afterAllModelsExecute

public void afterAllModelsExecute(int executionContext)
Invoked as notification that all auto-executing models have been executed. This method is always invoked as part of the display process.
Parameters:
executionContext - The context under which the models have been executed, one of WebActionHandler.RETRIEVE_CONTEXT, WebActionHandler.UPDATE_CONTEXT, WebActionHandler.DELETE_CONTEXT, WebActionHandler.INSERT_CONTEXT, or WebActionHandler.EXECUTE_CONTEXT
See Also:
WebActionHandler

onNoModelDataAvailable

public final void onNoModelDataAvailable(Model model,
                                         int executionContext)
Deprecated. This method is no longer supported

Invoked as notification that a given model returned false from its first method after being executed. The developer may, for exmaple, use this method to display alternate information, display a message that no data was available, or hide portions of the page.

This method is only called during web action handling. The reason this and similar methods exist is to provide the developer a chance to perform application logic upon auto-execution, where they have no other opportunity to do so because the invocation of auto-executing models is under the control of the framework.

Parameters:
model - The model that indicated it contained no data
executionContext - The context under which this model is being executed, one of WebActionHandler.RETRIEVE_CONTEXT, WebActionHandler.UPDATE_CONTEXT, WebActionHandler.DELETE_CONTEXT, WebActionHandler.INSERT_CONTEXT, or WebActionHandler.EXECUTE_CONTEXT
Returns:
True if the execution of the model should proceed, false to skip execution of the model
See Also:
WebActionHandler

onModelError

public void onModelError(Model model,
                         int executionContext,
                         ModelControlException exception)
                  throws ModelControlException
Invoked as notification that a given model threw a ModelControlException during auto-execution. The default implementation of this method is to rethrow the exception. This method is only called during web action handling. The reason this and similar methods exist is to provide the developer a chance to perform application logic upon auto-execution, where they have no other opportunity to do so because the invocation of auto- executing models is under the control of the framework.
Parameters:
model - The model that threw the provided exception
executionContext - The context under which this model is being executed, one of WebActionHandler.RETRIEVE_CONTEXT, WebActionHandler.UPDATE_CONTEXT, WebActionHandler.DELETE_CONTEXT, WebActionHandler.INSERT_CONTEXT, or WebActionHandler.EXECUTE_CONTEXT
exception - The exception thrown during auto-execution
See Also:
WebActionHandler

getWebActionModels

public Model[] getWebActionModels(int executionType)
Return the web action models associated with this view by execution type. These models, and only these models, will be used in the various web actions. It is up to the developer to return any models that fall into the appropriate categories.
Specified by:
getWebActionModels in interface WebActionHandler
Parameters:
executionType - The web action model type, one of MODEL_TYPE_RETRIEVE, MODEL_TYPE_UPDATE, MODEL_TYPE_DELETE, MODEL_TYPE_INSERT, or MODEL_TYPE_EXECUTE

isAutoRetrieveEnabled

public boolean isAutoRetrieveEnabled()
Returns the state of auto-retrieval. Auto-retrieval is the capability to automatically execute models upon display of a page. This capability is used to support automatic model navigation among other things.
Specified by:
isAutoRetrieveEnabled in interface WebActionHandler
Returns:
True if the display of this object will auto-execute auto-retrieving models

setAutoRetrieveEnabled

public void setAutoRetrieveEnabled(boolean autoRetrieveEnabled)
Sets the state of auto-retrieval for this request. Auto-retrieval is the capability to automatically execute models upon display of a page. This capability is used to support automatic model navigation among other things.
Specified by:
setAutoRetrieveEnabled in interface WebActionHandler
Parameters:
autoRetrieveEnabled - Turns on or off auto-retrieval on the next display. Set to false to supress execution of auto-retrieving/executing models.

getWebActionRowOffsetSessionKey

protected java.lang.String getWebActionRowOffsetSessionKey()
Returns the session attribute key used to store the row offset of this view for the user.

getWebActionModelOffset

protected int getWebActionModelOffset()
Gets the offset into the result set of the DatasetModel involved in the current WebAction.
Returns:
The result set offset for the DatasetModel involved in the current WebAction.

setWebActionModelOffset

protected void setWebActionModelOffset(int value)
Sets the offset into the result set of the DatasetModel involved in the current WebAction.
Parameters:
value - The result set offset for the DatasetModel involved in the current WebAction.

getWebActionMaxDisplayRowsSessionKey

protected java.lang.String getWebActionMaxDisplayRowsSessionKey()
Returns the session attribute key used to store the max display tiles of this view for the user.

getWebActionModelMaxDisplayTiles

protected int getWebActionModelMaxDisplayTiles()
Returns the value for the maximum number of tiles to display
Returns:
The value for the maximum number of tiles to display

setWebActionModelMaxDisplayTiles

protected void setWebActionModelMaxDisplayTiles(int value)
Sets the value for the maximum number of tiles to display

createDefaultExecutionContext

protected DatasetModelExecutionContext createDefaultExecutionContext()
Creates and returns an execution used for auto-retrieval. This context is used only when a previous auto-retrieval context is not available.
Returns:
The default execution context

getAutoRetrieveExecutionContext

protected DatasetModelExecutionContext getAutoRetrieveExecutionContext()
Returns the current auto-retrieval execution context, if present. This context will be used for execution of auto-retrieving models during the beginDisplay() method.
Returns:
The auto-retrieving execution context, or null if one has not been set in this view

setAutoRetrieveExecutionContext

protected void setAutoRetrieveExecutionContext(DatasetModelExecutionContext value)
Sets the current auto-retrieval execution context. This context will be used for execution of auto-retrieving models during the beginDisplay() method. A context is generally set by the web action handling logic to provide appropriate values when the page is redisplayed.
Parameters:
value - The auto-retrieving execution context or null to clear the current context

getRefreshActionExecutionContext

public DatasetModelExecutionContext getRefreshActionExecutionContext()
Returns an execution context suitable to the refresh web action.

getFirstActionExecutionContext

public DatasetModelExecutionContext getFirstActionExecutionContext()
Returns an execution context suitable to the first web action.

getNextActionExecutionContext

public DatasetModelExecutionContext getNextActionExecutionContext()
Returns an execution context suitable to the next web action.

getPreviousActionExecutionContext

public DatasetModelExecutionContext getPreviousActionExecutionContext()
Returns an execution context suitable to the previous web action.

getLastActionExecutionContext

public DatasetModelExecutionContext getLastActionExecutionContext()
Returns an execution context suitable to the last web action.

handleWebAction

public void handleWebAction(int actionType)
                     throws java.io.IOException,
                            javax.servlet.ServletException
Performs the specified standard web action. This invocation typically results in the execution of one or more web action models and sets up an auto-retrieving execution context for subsequent display of this view.
Specified by:
handleWebAction in interface WebActionHandler
Parameters:
actionType - The web action type to perform
See Also:
WebActionHandler

executeAutoRetrievingModels

public void executeAutoRetrievingModels()
                                 throws ModelControlException
Executes all of this view's auto-retrieving models. Although this method generally exists to support automatic web actions, it can be called directly by developers to simulate web action behavior.
Parameters:
context - The execution context used to execute the target models

executeAutoRetrievingModels

public void executeAutoRetrievingModels(DatasetModelExecutionContext context)
                                 throws ModelControlException
Executes all of this view's auto-retrieving models. Although this method generally exists to support automatic web actions, it can be called directly by developers to simulate web action behavior.
Parameters:
context - The execution context used to execute the target models

executeAutoUpdatingModels

public void executeAutoUpdatingModels(ModelExecutionContext context)
                               throws ModelControlException
Executes all of this view's updating models. Although this method generally exists to support automatic web actions, it can be called directly by developers to simulate web action behavior.
Parameters:
context - The execution context used to execute the target models

executeAutoInsertingModels

public void executeAutoInsertingModels(ModelExecutionContext context)
                                throws ModelControlException
Executes all of this view's inserting models. Although this method generally exists to support automatic web actions, it can be called directly by developers to simulate web action behavior.
Parameters:
context - The execution context used to execute the target models

executeAutoDeletingModels

public void executeAutoDeletingModels(ModelExecutionContext context)
                               throws ModelControlException
Executes all of this view's deleting models. Although this method generally exists to support automatic web actions, it can be called directly by developers to simulate web action behavior.
Parameters:
context - The execution context used to execute the target models

executeAutoExecutingModels

public void executeAutoExecutingModels(ModelExecutionContext context)
                                throws ModelControlException
Executes all of this view's executing models. Although this method generally exists to support automatic web actions, it can be called directly by developers to simulate web action behavior.
Parameters:
context - The execution context used to execute the target models

executeAutoRetrievingModel

public java.lang.Object executeAutoRetrievingModel(DatasetModelExecutionContext context,
                                                   Model m)
                                            throws ModelControlException
Executes the specified retrieving model. Although this method generally exists to support automatic web actions, it can be called directly by developers to simulate web action behavior.
Parameters:
context - The execution context used to execute the target models
m - The model to execute

executeAutoUpdatingModel

public java.lang.Object executeAutoUpdatingModel(ModelExecutionContext context,
                                                 Model m)
                                          throws ModelControlException
Executes the specified updating model. Although this method generally exists to support automatic web actions, it can be called directly by developers to simulate web action behavior.
Parameters:
context - The execution context used to execute the target models
m - The model to execute

executeAutoInsertingModel

public java.lang.Object executeAutoInsertingModel(ModelExecutionContext context,
                                                  Model m)
                                           throws ModelControlException
Executes the specified inserting model. Although this method generally exists to support automatic web actions, it can be called directly by developers to simulate web action behavior.
Parameters:
context - The execution context used to execute the target models
m - The model to execute

executeAutoDeletingModel

public java.lang.Object executeAutoDeletingModel(ModelExecutionContext context,
                                                 Model m)
                                          throws ModelControlException
Executes the specified deleting model. Although this method generally exists to support automatic web actions, it can be called directly by developers to simulate web action behavior.
Parameters:
context - The execution context used to execute the target models
m - The model to execute

executeAutoExecutingModel

public java.lang.Object executeAutoExecutingModel(ModelExecutionContext context,
                                                  Model m)
                                           throws ModelControlException
Executes the specified executing model. Although this method generally exists to support automatic web actions, it can be called directly by developers to simulate web action behavior.
Parameters:
context - The execution context used to execute the target models
m - The model to execute

getModel

public Model getModel(java.lang.Class clazz)
Convenience method to make obtaining a model instance by its default name from the ModelManager easier. It is a replacement for the following:
   getRequestContext().getModelManager().getModel(modelClass)
 

getViewBean

public ViewBean getViewBean(java.lang.Class clazz)
Convenience method to make obtaining a view bean instance from the ViewBeanManager easier. It is a replacement for the following:
   getRequestContext().getViewBeanManager().getViewBean(viewBeanClass)
 

getSession

public javax.servlet.http.HttpSession getSession()
Convenience method to make obtaining the HttpSession instance from the RequestContext easier. It is a replacement for the following:
   getRequestContext().getRequest().getSession(true)
 

appMessage

public void appMessage(java.lang.String message)
Convenience method to make obtaining the MessageWriter instance from the RequestContext easier. It is a replacement for the following:
   getRequestContext().getMessageWriter().println(message);
 
Overrides:
appMessage in class ContainerViewBase
Following copied from class: com.iplanet.jato.view.ContainerViewBase
Parameters:
message - The message to be added to the application message buffer