net.sf.shineframework.common.tx.context
Class StandardUserContext

java.lang.Object
  net.sf.shineframework.common.tx.context.BaseUserContext
      net.sf.shineframework.common.tx.context.StandardUserContext

All Implemented Interfaces:

java.io.Serializable, UserContext

Direct Known Subclasses:

StandardUserContext

public abstract class StandardUserContext
extends BaseUserContext

A standard user context. This is a simple implementation of a user context.

Author:

amirk

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sf.shineframework.common.tx.context.BaseUserContext

messageDefProvider

Constructor Summary

StandardUserContext()

Method Summary

void	addMessage(java.lang.String key) adds a message to the user context
Message	addMessage(java.lang.String key, java.lang.Object... params) adds a message with params to the user context
java.util.Iterator	getErrorsIterator() retrieves an iterator over all error messages in the user context
java.util.Iterator	getFatalIterator() retrieves an iterator over all fatal messages in the user context
java.util.Iterator	getInfosIterator() retrieves an iterator over all info messages in the user context
protected abstract MessageDef	getMessageDef(java.lang.String key)
java.util.List<Message>	getMessages() retrieves all message
java.io.Serializable	getUserData(java.lang.String key) retrieves user data according to a key
java.util.Iterator	getWarningsIterator() retrieves an iterator over all warning messages in the user context
boolean	isError() returns true if there is an error message on the context
boolean	isFailed() returns true if the transaction has already failed
boolean	isFailOnWarn() returns true if the transaction is set to fail on warning messages
boolean	isFatal() returns true if there is a fatal message on the context
boolean	isWarning() returns true if there is a warning message on the context
void	setFailOnWarn(boolean failOnWarn) sets whether or not to fail the transaction on warnings
void	setUserData(java.lang.String key, java.io.Serializable data) sets user data.

Methods inherited from class net.sf.shineframework.common.tx.context.BaseUserContext

getMessageDefProvider, setMessageDefProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardUserContext

public StandardUserContext()

Method Detail

addMessage

public void addMessage(java.lang.String key)

Description copied from interface: UserContext

adds a message to the user context

Parameters:

key - message key to add

addMessage

public Message addMessage(java.lang.String key,
                          java.lang.Object... params)

adds a message with params to the user context

Parameters:

key - message key to add

params - message parameter values

getErrorsIterator

public java.util.Iterator getErrorsIterator()

retrieves an iterator over all error messages in the user context

Returns:

error messages iterator that does not implement the remove() method

getFatalIterator

public java.util.Iterator getFatalIterator()

retrieves an iterator over all fatal messages in the user context

Returns:

fatal messages iterator that does not implement the remove() method

getInfosIterator

public java.util.Iterator getInfosIterator()

retrieves an iterator over all info messages in the user context

Returns:

info messages iterator that does not implement the remove() method

getMessageDef

protected abstract MessageDef getMessageDef(java.lang.String key)

getMessages

public java.util.List<Message> getMessages()

retrieves all message

Returns:

all messages on the user context

getUserData

public java.io.Serializable getUserData(java.lang.String key)

retrieves user data according to a key

Parameters:

key - user data key

Returns:

user data object

getWarningsIterator

public java.util.Iterator getWarningsIterator()

retrieves an iterator over all warning messages in the user context

Returns:

warning messages iterator that does not implement the remove() method

isError

public boolean isError()

Description copied from interface: UserContext

returns true if there is an error message on the context

Returns:

true if there is an error message on the context

isFailed

public boolean isFailed()

Description copied from interface: UserContext

returns true if the transaction has already failed

Returns:

true if the transaction has failed

isFailOnWarn

public boolean isFailOnWarn()

returns true if the transaction is set to fail on warning messages

Returns:

true when transaction is set to fail on warning

isFatal

public boolean isFatal()

Description copied from interface: UserContext

returns true if there is a fatal message on the context

Returns:

true if there is a fatal message on the context

isWarning

public boolean isWarning()

Description copied from interface: UserContext

returns true if there is a warning message on the context

Returns:

true if there is a warning message on the context

setFailOnWarn

public void setFailOnWarn(boolean failOnWarn)

sets whether or not to fail the transaction on warnings

Parameters:

failOnWarn - fail on warning (or not)

setUserData

public void setUserData(java.lang.String key,
                        java.io.Serializable data)

sets user data. The user context can carry multiple user data (serializable) objects. Each user data object is assigned a key (by the user) to allow this multiplexing.

Parameters:

key - user data key

data - user data object