com.appiancorp.common.struts

Class BaseUpdateAction

java.lang.Object

org.apache.struts.action.Action

com.appiancorp.common.struts.BaseAction

com.appiancorp.common.struts.BaseViewAction

com.appiancorp.common.struts.BaseUpdateAction

Direct Known Subclasses:

PortletUpdateAction

Deprecated.

The Portal functionality will be removed in a future release. Use the Tempo Interface for similar functionality.

@Deprecated
public abstract class BaseUpdateAction
extends BaseViewAction

Base Action class for all actions in the product.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FORWARD_CANCEL Deprecated. The name of the "cancel" ActionForward
static java.lang.String	FORWARD_INVALID_TOKEN Deprecated. Forward taken if the token is invalid (i.e. double submit)
static java.lang.String	FORWARD_PREPARE Deprecated. The name of the "prepare" ActionForward
static java.lang.String	REQUEST_FORM_STATE Deprecated. Request parameter for the state of the form.
static java.lang.String	REQUEST_RECOVERED Deprecated.
static java.lang.String	REQUEST_TOKEN Deprecated.
static java.lang.String	REQUEST_TOKEN_OVERRIDE Deprecated. Request parameter for overriding the token check.
static java.lang.String	STATE_PREPARE Deprecated.
static java.lang.String	STATE_SAVE Deprecated.
static java.lang.String	STATE_VALIDATE Deprecated.

Fields inherited from class com.appiancorp.common.struts.BaseAction

FORWARD_ERROR, FORWARD_NO_ACCESS, FORWARD_SUCCESS

Fields inherited from class org.apache.struts.action.Action

servlet

Constructor Summary

Constructors

Constructor and Description
BaseUpdateAction() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected org.apache.struts.action.ActionForward	afterPrepare(org.apache.struts.action.ActionMapping m_, org.apache.struts.action.ActionForm f_, javax.servlet.http.HttpServletRequest q_, javax.servlet.http.HttpServletResponse r_, org.apache.struts.action.ActionForward defaultForward_) Deprecated. Performed after the prepare(ActionMapping,ActionForm,HttpServletRequest,HttpServletResponse).
protected org.apache.struts.action.ActionErrors	afterValidate(org.apache.struts.action.ActionMapping m_, org.apache.struts.action.ActionForm f_, javax.servlet.http.HttpServletRequest q_, java.lang.String currentStep_) Deprecated. Performed after validate(ActionMapping,ActionForm,HttpServletRequest,String).
protected org.apache.struts.action.ActionForward	beforePrepare(org.apache.struts.action.ActionMapping m_, org.apache.struts.action.ActionForm f_, javax.servlet.http.HttpServletRequest q_, javax.servlet.http.HttpServletResponse r_) Deprecated. Performed before prepare(ActionMapping,ActionForm,HttpServletRequest,HttpServletResponse).
protected org.apache.struts.action.ActionErrors	beforeValidate(org.apache.struts.action.ActionMapping m_, org.apache.struts.action.ActionForm f_, javax.servlet.http.HttpServletRequest q_, java.lang.String currentStep_) Deprecated. Performed before validate(ActionMapping,ActionForm,HttpServletRequest,String).
protected org.apache.struts.action.ActionForward	handleInvalidToken(org.apache.struts.action.ActionMapping m_, org.apache.struts.action.ActionForm f_, javax.servlet.http.HttpServletRequest q_, javax.servlet.http.HttpServletResponse r_) Deprecated. Returns the ActionForward object mapped from this Action for invalid tokens
protected org.apache.struts.action.ActionForward	prepare(org.apache.struts.action.ActionMapping m_, org.apache.struts.action.ActionForm f_, javax.servlet.http.HttpServletRequest q_, javax.servlet.http.HttpServletResponse r_) Deprecated. Perpares the data, usually by populating the ActionForm to pre-populate a JSP form.
protected org.apache.struts.action.ActionErrors	validate(org.apache.struts.action.ActionMapping m_, org.apache.struts.action.ActionForm f_, javax.servlet.http.HttpServletRequest q_, java.lang.String currentStep_) Deprecated. Validates the data and returns any errors.

Methods inherited from class com.appiancorp.common.struts.BaseViewAction

addOutput, afterMain, beforeMain, getOutputValue, getServiceContext, main

Methods inherited from class com.appiancorp.common.struts.BaseAction

addError, addError, addError, addError, addError, addError, addError, addError, addMessage, addMessage, addMessage, addMessage, canAccess, decodeParameters, execute, generateToken, getAuthorizationActionName, getAuthorizationProvider, getValueFromRequest, getValueFromRequest, initBundle, isTokenValid, isTokenValid, requiresAuthorization, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, saveErrors, saveMessages, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_TOKEN_OVERRIDE

public static final java.lang.String REQUEST_TOKEN_OVERRIDE

Deprecated.

Request parameter for overriding the token check. If this parameter is present on the request, then the main method will be called (not the prepare).

See Also:

Constant Field Values

REQUEST_FORM_STATE

public static final java.lang.String REQUEST_FORM_STATE

Deprecated.

Request parameter for the state of the form. States include STATE_PREPARE, STATE_SAVE, and STATE_VALIDATE

See Also:

Constant Field Values

REQUEST_TOKEN

public static final java.lang.String REQUEST_TOKEN

Deprecated.

See Also:

Constant Field Values

REQUEST_RECOVERED

public static final java.lang.String REQUEST_RECOVERED

Deprecated.

See Also:

Constant Field Values

STATE_PREPARE

public static final java.lang.String STATE_PREPARE

Deprecated.

See Also:

Constant Field Values

STATE_SAVE

public static final java.lang.String STATE_SAVE

Deprecated.

See Also:

Constant Field Values

STATE_VALIDATE

public static final java.lang.String STATE_VALIDATE

Deprecated.

See Also:

Constant Field Values

FORWARD_CANCEL

public static final java.lang.String FORWARD_CANCEL

Deprecated.

The name of the "cancel" ActionForward

See Also:

Constant Field Values

FORWARD_PREPARE

public static final java.lang.String FORWARD_PREPARE

Deprecated.

The name of the "prepare" ActionForward

See Also:

Constant Field Values

FORWARD_INVALID_TOKEN

public static final java.lang.String FORWARD_INVALID_TOKEN

Deprecated.

Forward taken if the token is invalid (i.e. double submit)

See Also:

Constant Field Values

Constructor Detail

BaseUpdateAction

public BaseUpdateAction()

Deprecated.

Method Detail

beforeValidate

protected org.apache.struts.action.ActionErrors beforeValidate(org.apache.struts.action.ActionMapping m_,
                                                               org.apache.struts.action.ActionForm f_,
                                                               javax.servlet.http.HttpServletRequest q_,
                                                               java.lang.String currentStep_)

Deprecated.

Performed before validate(ActionMapping,ActionForm,HttpServletRequest,String). Override to implement.

Parameters:

m_ - the action mapping

f_ - the action form

q_ - the request

currentStep_ - the current step in a UI wizard, if applicable

Returns:

any errors that may have occurred during execution of this method

validate

protected org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping m_,
                                                         org.apache.struts.action.ActionForm f_,
                                                         javax.servlet.http.HttpServletRequest q_,
                                                         java.lang.String currentStep_)

Deprecated.

Validates the data and returns any errors. Can be called explicitly, but also called before BaseViewAction.main(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) is executed. Override to implement.

Parameters:

m_ - the action mapping

f_ - the action form

q_ - the request

currentStep_ - the current step in a UI wizard, if applicable

Returns:

any errors that may have occurred during execution of this method, particularly validation-related

afterValidate

protected org.apache.struts.action.ActionErrors afterValidate(org.apache.struts.action.ActionMapping m_,
                                                              org.apache.struts.action.ActionForm f_,
                                                              javax.servlet.http.HttpServletRequest q_,
                                                              java.lang.String currentStep_)

Deprecated.

Performed after validate(ActionMapping,ActionForm,HttpServletRequest,String). Override to implement.

Parameters:

m_ - the action mapping

f_ - the action form

q_ - the request

currentStep_ - the current step in a UI wizard, if applicable

Returns:

any errors that may have occurred during execution of this method

prepare

protected org.apache.struts.action.ActionForward prepare(org.apache.struts.action.ActionMapping m_,
                                                         org.apache.struts.action.ActionForm f_,
                                                         javax.servlet.http.HttpServletRequest q_,
                                                         javax.servlet.http.HttpServletResponse r_)

Deprecated.

Perpares the data, usually by populating the ActionForm to pre-populate a JSP form. This implementation simply returns the "prepare" ActionForward destination. Override to provide a custom implementation.

Parameters:

m_ - The ActionMapping used to select this instance

f_ - The optional ActionForm bean for this request (if any)

q_ - The HTTP request we are processing

r_ - The HTTP response we are creating

Returns:

the destination ActionForward

beforePrepare

protected org.apache.struts.action.ActionForward beforePrepare(org.apache.struts.action.ActionMapping m_,
                                                               org.apache.struts.action.ActionForm f_,
                                                               javax.servlet.http.HttpServletRequest q_,
                                                               javax.servlet.http.HttpServletResponse r_)

Deprecated.

Performed before prepare(ActionMapping,ActionForm,HttpServletRequest,HttpServletResponse). Override to implement.

Parameters:

m_ - The ActionMapping used to select this instance

f_ - The optional ActionForm bean for this request (if any)

q_ - The HTTP request we are processing

r_ - The HTTP response we are creating

Returns:

the destination ActionForward

afterPrepare

protected org.apache.struts.action.ActionForward afterPrepare(org.apache.struts.action.ActionMapping m_,
                                                              org.apache.struts.action.ActionForm f_,
                                                              javax.servlet.http.HttpServletRequest q_,
                                                              javax.servlet.http.HttpServletResponse r_,
                                                              org.apache.struts.action.ActionForward defaultForward_)

Deprecated.

Performed after the prepare(ActionMapping,ActionForm,HttpServletRequest,HttpServletResponse). Override to implement.

Parameters:

m_ - The ActionMapping used to select this instance

f_ - The optional ActionForm bean for this request (if any)

q_ - The HTTP request we are processing

r_ - The HTTP response we are creating

defaultForward_ - the default action forward

Returns:

the destination ActionForward

handleInvalidToken

protected org.apache.struts.action.ActionForward handleInvalidToken(org.apache.struts.action.ActionMapping m_,
                                                                    org.apache.struts.action.ActionForm f_,
                                                                    javax.servlet.http.HttpServletRequest q_,
                                                                    javax.servlet.http.HttpServletResponse r_)

Deprecated.

Returns the ActionForward object mapped from this Action for invalid tokens

Parameters:

m_ - The ActionMapping used to select this instance

f_ - The optional ActionForm bean for this request (if any)

q_ - The HTTP request we are processing

r_ - The HTTP response we are creating

Returns:

the destination ActionForward object