Package com.appiancorp.common.appianwebmvc

Class BaseUpdateAction

java.lang.Object

com.appiancorp.web.framework.kernel.main.Action

com.appiancorp.common.appianwebmvc.BaseAction

com.appiancorp.common.appianwebmvc.BaseViewAction

com.appiancorp.common.appianwebmvc.BaseUpdateAction

All Implemented Interfaces:

com.appiancorp.web.framework.kernel.main.IAction

Direct Known Subclasses:

PortletUpdateAction

@Deprecated
public abstract class BaseUpdateAction
extends BaseViewAction

Deprecated.

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

Base Action class for all actions in the product.

Field Summary

Fields

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

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

FORWARD_ERROR, FORWARD_NO_ACCESS, FORWARD_SUCCESS

Fields inherited from class com.appiancorp.web.framework.kernel.main.Action

servlet

Constructor Summary

Constructors

Constructor	Description
BaseUpdateAction()	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected com.appiancorp.web.framework.kernel.main.IActionForward	afterPrepare(com.appiancorp.web.framework.kernel.main.IActionMapping m_, com.appiancorp.web.framework.kernel.main.IActionForm f_, javax.servlet.http.HttpServletRequest q_, javax.servlet.http.HttpServletResponse r_, com.appiancorp.web.framework.kernel.main.IActionForward defaultForward_)	Deprecated. Performed after the prepare(IActionMapping, IActionForm, HttpServletRequest, HttpServletResponse).
protected com.appiancorp.web.framework.kernel.main.ActionErrors	afterValidate(com.appiancorp.web.framework.kernel.main.IActionMapping m_, com.appiancorp.web.framework.kernel.main.IActionForm f_, javax.servlet.http.HttpServletRequest q_, String currentStep_)	Deprecated. Performed after validate(IActionMapping, IActionForm, HttpServletRequest, String).
protected com.appiancorp.web.framework.kernel.main.IActionForward	beforePrepare(com.appiancorp.web.framework.kernel.main.IActionMapping m_, com.appiancorp.web.framework.kernel.main.IActionForm f_, javax.servlet.http.HttpServletRequest q_, javax.servlet.http.HttpServletResponse r_)	Deprecated. Performed before prepare(IActionMapping, IActionForm, HttpServletRequest, HttpServletResponse).
protected com.appiancorp.web.framework.kernel.main.ActionErrors	beforeValidate(com.appiancorp.web.framework.kernel.main.IActionMapping m_, com.appiancorp.web.framework.kernel.main.IActionForm f_, javax.servlet.http.HttpServletRequest q_, String currentStep_)	Deprecated. Performed before validate(IActionMapping, IActionForm, HttpServletRequest, String).
protected com.appiancorp.web.framework.kernel.main.IActionForward	handleInvalidToken(com.appiancorp.web.framework.kernel.main.IActionMapping m_, com.appiancorp.web.framework.kernel.main.IActionForm f_, javax.servlet.http.HttpServletRequest q_, javax.servlet.http.HttpServletResponse r_)	Deprecated. Returns the ActionForward object mapped from this Action for invalid tokens
protected com.appiancorp.web.framework.kernel.main.IActionForward	prepare(com.appiancorp.web.framework.kernel.main.IActionMapping m_, com.appiancorp.web.framework.kernel.main.IActionForm 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 boolean	shouldSetSessionAttributes(javax.servlet.http.HttpServletRequest q)	Deprecated.
protected com.appiancorp.web.framework.kernel.main.ActionErrors	validate(com.appiancorp.web.framework.kernel.main.IActionMapping m_, com.appiancorp.web.framework.kernel.main.IActionForm f_, javax.servlet.http.HttpServletRequest q_, String currentStep_)	Deprecated. Validates the data and returns any errors.

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

addOutput, afterMain, beforeMain, getOutputValue, getServiceContext, main

Methods inherited from class com.appiancorp.common.appianwebmvc.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 com.appiancorp.web.framework.kernel.main.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 Details

REQUEST_TOKEN_OVERRIDE

public static final 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 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 String REQUEST_TOKEN

Deprecated.

See Also:

• Constant Field Values

REQUEST_RECOVERED

public static final String REQUEST_RECOVERED

Deprecated.

See Also:

• Constant Field Values

STATE_PREPARE

public static final String STATE_PREPARE

Deprecated.

See Also:

• Constant Field Values

STATE_SAVE

public static final String STATE_SAVE

Deprecated.

See Also:

• Constant Field Values

STATE_VALIDATE

public static final String STATE_VALIDATE

Deprecated.

See Also:

• Constant Field Values

FORWARD_CANCEL

public static final String FORWARD_CANCEL

Deprecated.

The name of the "cancel" ActionForward

See Also:

• Constant Field Values

FORWARD_PREPARE

public static final String FORWARD_PREPARE

Deprecated.

The name of the "prepare" ActionForward

See Also:

• Constant Field Values

FORWARD_INVALID_TOKEN

public static final String FORWARD_INVALID_TOKEN

Deprecated.

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

See Also:

• Constant Field Values

Constructor Details

BaseUpdateAction

public BaseUpdateAction()

Deprecated.

Method Details

beforeValidate

protected com.appiancorp.web.framework.kernel.main.ActionErrors beforeValidate(com.appiancorp.web.framework.kernel.main.IActionMapping m_,
 com.appiancorp.web.framework.kernel.main.IActionForm f_,
 javax.servlet.http.HttpServletRequest q_,
 String currentStep_)

Deprecated.

Performed before validate(IActionMapping, IActionForm, 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 com.appiancorp.web.framework.kernel.main.ActionErrors validate(com.appiancorp.web.framework.kernel.main.IActionMapping m_,
 com.appiancorp.web.framework.kernel.main.IActionForm f_,
 javax.servlet.http.HttpServletRequest q_,
 String currentStep_)

Deprecated.

Validates the data and returns any errors. Can be called explicitly, but also called before BaseViewAction.main(com.appiancorp.web.framework.kernel.main.IActionMapping, com.appiancorp.web.framework.kernel.main.IActionForm, 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 com.appiancorp.web.framework.kernel.main.ActionErrors afterValidate(com.appiancorp.web.framework.kernel.main.IActionMapping m_,
 com.appiancorp.web.framework.kernel.main.IActionForm f_,
 javax.servlet.http.HttpServletRequest q_,
 String currentStep_)

Deprecated.

Performed after validate(IActionMapping, IActionForm, 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 com.appiancorp.web.framework.kernel.main.IActionForward prepare(com.appiancorp.web.framework.kernel.main.IActionMapping m_,
 com.appiancorp.web.framework.kernel.main.IActionForm 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 com.appiancorp.web.framework.kernel.main.IActionForward beforePrepare(com.appiancorp.web.framework.kernel.main.IActionMapping m_,
 com.appiancorp.web.framework.kernel.main.IActionForm f_,
 javax.servlet.http.HttpServletRequest q_,
 javax.servlet.http.HttpServletResponse r_)

Deprecated.

Performed before prepare(IActionMapping, IActionForm, 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 com.appiancorp.web.framework.kernel.main.IActionForward afterPrepare(com.appiancorp.web.framework.kernel.main.IActionMapping m_,
 com.appiancorp.web.framework.kernel.main.IActionForm f_,
 javax.servlet.http.HttpServletRequest q_,
 javax.servlet.http.HttpServletResponse r_,
 com.appiancorp.web.framework.kernel.main.IActionForward defaultForward_)

Deprecated.

Performed after the prepare(IActionMapping, IActionForm, 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

shouldSetSessionAttributes

protected boolean shouldSetSessionAttributes(javax.servlet.http.HttpServletRequest q)

Deprecated.

handleInvalidToken

protected com.appiancorp.web.framework.kernel.main.IActionForward handleInvalidToken(com.appiancorp.web.framework.kernel.main.IActionMapping m_,
 com.appiancorp.web.framework.kernel.main.IActionForm 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