com.ivata.mask.web.struts
Class InputMaskAction

java.lang.Object
  org.apache.struts.action.Action
      com.ivata.mask.web.struts.MaskAction
          com.ivata.mask.web.struts.InputMaskAction

public class InputMaskAction

extends MaskAction

Add, amend or remove an existing value object in the list of value objects.

Since:

ivata masks 0.4 (2004-05-10)

Version:

$Revision: 1.12.2.1 $

Author:

Colin MacLeod colin.macleod@ivata.com

Field Summary

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

defaultLocale, servlet

Constructor Summary

InputMaskAction(com.ivata.mask.MaskFactory maskFactoryParam, com.ivata.mask.persistence.PersistenceManager persistenceManagerParam, MaskAuthenticator authenticatorParam)
Create a new AddAction with the given value object locator.

Method Summary

java.lang.String	execute(org.apache.struts.action.ActionMapping mappingParam, org.apache.struts.action.ActionErrors errorsParam, org.apache.struts.action.ActionForm formParam, javax.servlet.http.HttpServletRequest requestParam, javax.servlet.http.HttpServletResponse responseParam, javax.servlet.http.HttpSession sessionParam) Overridden to trap the Clear/New button.
java.lang.String	onConfirm(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionErrors errors, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpSession session, java.lang.String defaultForward) Adds the value object to the list, or amends an existing value object.
java.lang.String	onDelete(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionErrors errors, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpSession session, java.lang.String defaultForward) Removes the value object from the list.

Methods inherited from class com.ivata.mask.web.struts.MaskAction

clear, execute, getAuthenticator, getFromRequestOrForm, getFromRequestOrForm, getInputMask, getListMask, getMaskFactory, isCancelled, setLogin

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

addErrors, addMessages, execute, generateToken, getDataSource, getDataSource, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Constructor Detail

InputMaskAction

public InputMaskAction(com.ivata.mask.MaskFactory maskFactoryParam,
                       com.ivata.mask.persistence.PersistenceManager persistenceManagerParam,
                       MaskAuthenticator authenticatorParam)

Create a new AddAction with the given value object locator.

Parameters:

persistenceManagerParam - used to locate the value objects by their shared base class.

maskFactoryParam - Refer to MaskAction.MaskAction(com.ivata.mask.MaskFactory, com.ivata.mask.web.struts.MaskAuthenticator).

authenticatorParam - Refer to MaskAction.MaskAction(com.ivata.mask.MaskFactory, com.ivata.mask.web.struts.MaskAuthenticator).

Method Detail

execute

public java.lang.String execute(org.apache.struts.action.ActionMapping mappingParam,
                                org.apache.struts.action.ActionErrors errorsParam,
                                org.apache.struts.action.ActionForm formParam,
                                javax.servlet.http.HttpServletRequest requestParam,
                                javax.servlet.http.HttpServletResponse responseParam,
                                javax.servlet.http.HttpSession sessionParam)
                         throws com.ivata.mask.util.SystemException

Overridden to trap the Clear/New button. If this is pressed, the forward new is returned which you can then route to NewAction via the Struts framework.

Overrides:

execute in class MaskAction

Parameters:

mappingParam - Refer to MaskAction.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession).

errorsParam - Refer to MaskAction.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession).

formParam - Refer to MaskAction.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession).

requestParam - Refer to MaskAction.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession).

responseParam - Refer to MaskAction.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession).

sessionParam - Refer to MaskAction.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession).

Returns:

new if the new/clear button was pressed, otherwise the same as the super constructor.

Throws:

com.ivata.mask.util.SystemException - Refer to MaskAction.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession).

onConfirm

public java.lang.String onConfirm(org.apache.struts.action.ActionMapping mapping,
                                  org.apache.struts.action.ActionErrors errors,
                                  org.apache.struts.action.ActionForm form,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response,
                                  javax.servlet.http.HttpSession session,
                                  java.lang.String defaultForward)
                           throws com.ivata.mask.util.SystemException

Adds the value object to the list, or amends an existing value object.

Overrides:

onConfirm in class MaskAction

Parameters:

mapping - Refer to MaskAction.onConfirm(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).

errors - Refer to MaskAction.onConfirm(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).

form - Refer to MaskAction.onConfirm(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).

request - Refer to MaskAction.onConfirm(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).

response - Refer to MaskAction.onConfirm(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).

session - Refer to MaskAction.onConfirm(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).

defaultForward - Refer to MaskAction.onConfirm(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).

Returns:

Refer to MaskAction.onConfirm(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).

Throws:

com.ivata.mask.util.SystemException - Refer to MaskAction.onConfirm(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).

onDelete

public java.lang.String onDelete(org.apache.struts.action.ActionMapping mapping,
                                 org.apache.struts.action.ActionErrors errors,
                                 org.apache.struts.action.ActionForm form,
                                 javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 javax.servlet.http.HttpSession session,
                                 java.lang.String defaultForward)
                          throws com.ivata.mask.util.SystemException

Removes the value object from the list.

Overrides:

onDelete in class MaskAction

Parameters:

mapping - Refer to MaskAction.onDelete(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).

errors - Refer to MaskAction.onDelete(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).

form - Refer to MaskAction.onDelete(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).

request - Refer to MaskAction.onDelete(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).

response - Refer to MaskAction.onDelete(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).

session - Refer to MaskAction.onDelete(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).

defaultForward - usually "delete". This is the forward it is suggested you use, if everything is ok.

Returns:

Refer to MaskAction.onDelete(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).

Throws:

com.ivata.mask.util.SystemException - Refer to MaskAction.onDelete(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionErrors, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpSession, java.lang.String).