com.iplanet.jato.view
Interface WebActionHandler

All Superinterfaces:
WebActions
All Known Subinterfaces:
ViewBean
All Known Implementing Classes:
RequestHandlingViewBase, RequestHandlingTiledViewBase

public interface WebActionHandler
extends WebActions

Methods used to handle invocations of high-level, value-added JATO behaviors called web actions. These additional behaviors are currently focused on auto- execution of models associated with a given view. These models are known as web action models, and are unique only in that they must be returned from the getWebActionModels() method according to execution type in order to be used during a web action.

Version:
JATO/1.2.2 $Id: WebActionHandler.java,v 1.8 2002/03/16 03:26:42 todd Exp $

Field Summary
static int DELETE_CONTEXT
           
static int EXECUTE_CONTEXT
           
static int INSERT_CONTEXT
           
static int MODEL_TYPE_DELETE
           
static int MODEL_TYPE_EXECUTE
           
static int MODEL_TYPE_INSERT
           
static int MODEL_TYPE_RETRIEVE
           
static int MODEL_TYPE_UPDATE
           
static int RETRIEVE_CONTEXT
           
static int 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
 
Method Summary
 Model[] getWebActionModels(int modelType)
          Return the web action models associated with this view by execution type.
 void handleWebAction(int actionType)
          Performs the specified web action
 boolean isAutoRetrieveEnabled()
          Returns the state of auto-retrieval.
 void setAutoRetrieveEnabled(boolean autoRetrieve)
          Sets the state of auto-retrieval for this request.
 

Field Detail

MODEL_TYPE_RETRIEVE

public static final int MODEL_TYPE_RETRIEVE

MODEL_TYPE_UPDATE

public static final int MODEL_TYPE_UPDATE

MODEL_TYPE_DELETE

public static final int MODEL_TYPE_DELETE

MODEL_TYPE_INSERT

public static final int MODEL_TYPE_INSERT

MODEL_TYPE_EXECUTE

public static final int MODEL_TYPE_EXECUTE

RETRIEVE_CONTEXT

public static final int RETRIEVE_CONTEXT

UPDATE_CONTEXT

public static final int UPDATE_CONTEXT

DELETE_CONTEXT

public static final int DELETE_CONTEXT

INSERT_CONTEXT

public static final int INSERT_CONTEXT

EXECUTE_CONTEXT

public static final int EXECUTE_CONTEXT
Method Detail

handleWebAction

public void handleWebAction(int actionType)
                     throws java.io.IOException,
                            javax.servlet.ServletException
Performs the specified web action
Parameters:
actionType - The web action type to perform

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.
Returns:
True if the display of this object will auto-execute auto-retrieving models

setAutoRetrieveEnabled

public void setAutoRetrieveEnabled(boolean autoRetrieve)
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.
Parameters:
autoRetrieve - Turns on or off auto-retrieval on the next display. Set to false to supress execution of auto-retrieving/executing models.

getWebActionModels

public Model[] getWebActionModels(int modelType)
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.
Parameters:
modelType - The web action model type, one of MODEL_TYPE_RETRIEVE, MODEL_TYPE_UPDATE, MODEL_TYPE_DELETE, MODEL_TYPE_INSERT, or MODEL_TYPE_EXECUTE