net.sf.shineframework.common.tx.context
Interface UserContext

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BaseUserContext, StandardUserContext, StandardUserContext

public interface UserContext
extends java.io.Serializable

a user context

Author:

amirk

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
java.util.List	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() sets whether or not to fail the transaction on warnings
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.

Method Detail

addMessage

void addMessage(java.lang.String key)

adds a message to the user context

Parameters:

key - message key to add

addMessage

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 key parameter values

getErrorsIterator

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

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

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

getMessages

java.util.List getMessages()

retrieves all message

Returns:

all messages on the user context

getUserData

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

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

isFailOnWarn

boolean isFailOnWarn()

sets whether or not to fail the transaction on warnings

Parameters:

failOnWarn - fail on warning (or not)

setFailOnWarn

void setFailOnWarn(boolean failOnWarn)

sets whether or not to fail the transaction on warnings

Parameters:

failOnWarn - fail on warning (or not)

setUserData

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

isFailed

boolean isFailed()

returns true if the transaction has already failed

Returns:

true if the transaction has failed

isFatal

boolean isFatal()

returns true if there is a fatal message on the context

Returns:

true if there is a fatal message on the context

isError

boolean isError()

returns true if there is an error message on the context

Returns:

true if there is an error message on the context

isWarning

boolean isWarning()

returns true if there is a warning message on the context

Returns:

true if there is a warning message on the context