com.ivata.mask.web.struts
Class MaskForm

java.lang.Object
  org.apache.struts.action.ActionForm
      com.ivata.mask.web.struts.DialogForm
          com.ivata.mask.web.struts.MaskForm

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

InputMaskForm, ListForm

public abstract class MaskForm

extends DialogForm

This form is the base class of all forms containing mask information.

Since:

ivata masks 0.1.1 (2005-05-16)

Version:

$Revision: 1.7 $

Author:

Colin MacLeod colin.macleod@ivata.com

See Also:

Serialized Form

Field Summary

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

multipartRequestHandler, servlet

Constructor Summary

protected

MaskForm(com.ivata.mask.Mask maskParam, java.lang.Class baseClassParam) Construct an instance of this class.

Method Summary

protected void	clear() Refer to .
java.lang.Class	getBaseClass() Defines the base class of all objects in the value object list.
com.ivata.mask.Mask	getMask() Mask containing all the field definitions for this list.
com.ivata.mask.validation.ValidationErrors	validate(javax.servlet.http.HttpServletRequest requestParam, javax.servlet.http.HttpSession sessionParam) This method overridden to retrieve errors from the request processor.

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

getApply, getBundle, getClear, getDefaultForwardApply, getDefaultForwardDelete, getDefaultForwardOk, getDeleteConfirm, getDeleteKey, getDeleteWarn, getHelpKey, getOk, reset, setApply, setBundle, setClear, setDefaultForwardApply, setDefaultForwardDelete, setDefaultForwardOk, setDeleteConfirm, setDeleteKey, setDeleteWarn, setHelpKey, setOk, validate

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

getMultipartRequestHandler, getServlet, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

MaskForm

protected MaskForm(com.ivata.mask.Mask maskParam,
                   java.lang.Class baseClassParam)

Construct an instance of this class.

Parameters:

maskParam - mask associated with this form.

baseClassParam - base class of all value objects in this form.

Method Detail

clear

protected void clear()
              throws javax.naming.OperationNotSupportedException

Refer to .

Overrides:

clear in class DialogForm

Throws:

javax.naming.OperationNotSupportedException

See Also:

DialogForm.clear()

getBaseClass

public final java.lang.Class getBaseClass()

Defines the base class of all objects in the value object list.

Returns:

base class of all objects in the value object list.

getMask

public final com.ivata.mask.Mask getMask()

Mask containing all the field definitions for this list.

Returns:

mask containing all the field definitions for this list.

validate

public com.ivata.mask.validation.ValidationErrors validate(javax.servlet.http.HttpServletRequest requestParam,
                                                           javax.servlet.http.HttpSession sessionParam)

This method overridden to retrieve errors from the request processor. This will allocate any errors which occurred as the form was set.

Overrides:

validate in class DialogForm

Parameters:

requestParam - Refer to DialogForm.validate(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest).

sessionParam - Refer to DialogForm.validate(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest).

Returns:

errors from the super class, with errors from the request (if any). Never returns null.