kiurubeans
Class KiuruHandler

java.lang.Object
  |
  +--kiurubeans.KiuruHandler

All Implemented Interfaces:

EnumType

Direct Known Subclasses:

EntityHandler, SearchHandler

public abstract class KiuruHandler

extends java.lang.Object

implements EnumType

General-purpose handler bean. Support for User and Error included.

This should be used as a superclass for all Handler Beans.

Field Summary

static int

NO_ACTION Default action for all handlers.

Constructor Summary

KiuruHandler()
Dummy constructor for KiuruHandler

KiuruHandler(Error error)
Dummy constructor with error.

Method Summary

protected void	addError(java.lang.String s) Adds string to errors to be displayed.
protected void	addNotice(java.lang.String s) Add string to notices to be displayed.
void	clearEmptyParameters(javax.servlet.http.HttpServletRequest request) Ensures empty request parameters are clearer when entity is posted.
protected abstract void	defaultAction() Performs action based on actionType.
protected abstract void	doClearActionState(javax.servlet.http.HttpServletRequest request) Implementation of clearing action state.
protected abstract void	doClearEmptyParameters(javax.servlet.http.HttpServletRequest request) Implementation for clearing empty parameters.
int	getEnumState() Returns current state.
Error	getError() Returns current error object.
protected java.lang.String	getLangId() Returns user's language id as String.
protected int	getMaxState() Returns current max state value.
boolean	getOk() Returns if user-entered properties are ok.
User	getUser() Returns current user.
boolean	performAction() Performs action based on actionType (eg. addNew, modify, post, delete)
void	resetActionState(javax.servlet.http.HttpServletRequest request) Ensures bean state is reseted when editing a new record.
java.lang.String	resetErrorState() Returns errorstring (if exists) and resets ok-field & actiontype.
void	setEnumState(int state) Sets current state.
void	setError(Error error) Sets current error object.
void	setOk(boolean b) OK may be false when processing invalid input values for entity attributes or search parameters.
void	setUser(User user) Sets current user.

Methods inherited from class java.lang.Object

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

Field Detail

NO_ACTION

public static final int NO_ACTION

Default action for all handlers.

See Also:

Constant Field Values

Constructor Detail

KiuruHandler

public KiuruHandler()

Dummy constructor for KiuruHandler

KiuruHandler

public KiuruHandler(Error error)

Dummy constructor with error.

Parameters:

error - error object for this instance.

Method Detail

getMaxState

protected int getMaxState()

Returns current max state value. Inherited classes may override this when new states are introduced.

Returns:

max state value

getEnumState

public int getEnumState()

Returns current state.

Specified by:

getEnumState in interface EnumType

Returns:

current state.

setEnumState

public void setEnumState(int state)

Sets current state.

Specified by:

setEnumState in interface EnumType

Parameters:

state - constant.

Throws:

java.lang.IllegalArgumentException - if state is not valid.

getUser

public User getUser()

Returns current user.

Returns:

current user

setUser

public void setUser(User user)

Sets current user.

Parameters:

user - user to be set

getError

public Error getError()

Returns current error object.

Returns:

current error

setError

public void setError(Error error)

Sets current error object.

Parameters:

error - error to be set

getOk

public boolean getOk()

Returns if user-entered properties are ok.

Returns:

if user-entered properties are ok

setOk

public void setOk(boolean b)

OK may be false when processing invalid input values for entity attributes or search parameters.

Parameters:

b - value for Ok

getLangId

protected java.lang.String getLangId()

Returns user's language id as String. If user is not assigned, returns 1. works even if user is not set.

Returns:

user's language id.

addError

protected void addError(java.lang.String s)

Adds string to errors to be displayed.

Parameters:

s - Error string

addNotice

protected void addNotice(java.lang.String s)

Add string to notices to be displayed.

Parameters:

s - Notice string

defaultAction

protected abstract void defaultAction()
                               throws java.lang.Exception

Performs action based on actionType. Called from performAction. Descendant classes should override this and call the same method in inherited class as default.

Throws:

java.lang.Exception - If something went wrong during actual executed action.

See Also:

performAction()

performAction

public boolean performAction()

Performs action based on actionType (eg. addNew, modify, post, delete)

Returns:

true if action was successful, false otherwise

doClearActionState

protected abstract void doClearActionState(javax.servlet.http.HttpServletRequest request)

Implementation of clearing action state. Inherited classes should always override this.

Parameters:

request - Http request used for parameter parsing.

doClearEmptyParameters

protected abstract void doClearEmptyParameters(javax.servlet.http.HttpServletRequest request)

Implementation for clearing empty parameters. Descendant classes override this.

Parameters:

request - Http request used for parameter parsing.

resetActionState

public void resetActionState(javax.servlet.http.HttpServletRequest request)

Ensures bean state is reseted when editing a new record.

Method is called in the beginning of UI (not Handler!) JSP page. State reset may depend on request parameters.

Parameters:

request - HTTP request with parameters

See Also:

doClearActionState(HttpServletRequest)

clearEmptyParameters

public void clearEmptyParameters(javax.servlet.http.HttpServletRequest request)

Ensures empty request parameters are clearer when entity is posted.

If bean is used in a JSP, this should be called in the beginning of page. If form content is "" or null it is not sent via HTTP, so those fields must be cleared manually. Method may be called from a handler or UI page. Descendant classes should redefine conditions for calling doClearEmpty parameters method.

Parameters:

request - HTTP request with parameters

See Also:

doClearEmptyParameters(HttpServletRequest)

resetErrorState

public java.lang.String resetErrorState()

Returns errorstring (if exists) and resets ok-field & actiontype. Usually called in the beginning of a page.
Note. resetErrorState & ResetActionState should not be merged. ResetActionState is called only on UI pages.

Returns:

errorstring. Usually not needed. shared include file showerrorblock shows error in JSP page.