org.opensubsystems.core.util
Class Messages

java.lang.Object
  org.opensubsystems.core.util.Messages

public class Messages
extends java.lang.Object

Object which collects messages to report to user. The messages might be tied to categories which then decide how are they displayed to user. Category can represent the purpose of the message such as error or information or it can represent screen object such as control, which contains data that caused the error.

Version:

$Id: Messages.java,v 1.4 2007/01/07 06:14:00 bastafidli Exp $

Author:

Miro Halas

Code reviewer:

Miro Halas

Code reviewed:

Initial revision

Field Summary

static java.lang.String	ACCESSRIGHT_ERRORS Key used to store nonspecific errors.
static java.lang.String	ALL Key used to store all errors and info messages.
static java.lang.String	ALL_ERRORS Key used to store all errors.
static java.lang.String	INFORMATIONS Key used to store informations not errors
protected java.util.Map	m_mpMessages Map which collects messages
static java.lang.String	NONSPECIFIC_ERRORS Key used to store nonspecific errors.

Constructor Summary

Messages()
Construct new error object.

Method Summary

void	addErrorMessage(java.lang.String strMessage) Add new nonspecific message to the list of error messages.
void	addMessage(java.lang.Object messageCategory, java.lang.String strMessage) Add new message for a specific category.
void	addMessages(Messages erMessages) Method to merge Messages
java.util.List	getAllErrorMessages() Returns list of all error messages.
java.lang.String	getAllErrorMessages(java.lang.String strDeliminer) Returns String with all messages divided by deliminer.
java.util.List	getAllMessages() Returns list of all messages.
java.util.List	getInfoMessages() Returns list of all info messages.
java.util.List	getMessages(java.lang.Object messageCategory) Returns list of all messages for a given category.
java.lang.String	getMessages(java.lang.Object messageCategory, java.lang.String strDeliminer) Returns String with all messages for a given category divided by deliminer.
java.util.List	getNonSpecificMessages() Returns list of all nonspecific messages.

Methods inherited from class java.lang.Object

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

Field Detail

NONSPECIFIC_ERRORS

public static final java.lang.String NONSPECIFIC_ERRORS

Key used to store nonspecific errors.

See Also:

Constant Field Values

ACCESSRIGHT_ERRORS

public static final java.lang.String ACCESSRIGHT_ERRORS

Key used to store nonspecific errors.

See Also:

Constant Field Values

ALL_ERRORS

public static final java.lang.String ALL_ERRORS

Key used to store all errors.

See Also:

Constant Field Values

ALL

public static final java.lang.String ALL

Key used to store all errors and info messages.

See Also:

Constant Field Values

INFORMATIONS

public static final java.lang.String INFORMATIONS

Key used to store informations not errors

See Also:

Constant Field Values

m_mpMessages

protected java.util.Map m_mpMessages

Map which collects messages

Constructor Detail

Messages

public Messages()

Construct new error object.

Method Detail

addErrorMessage

public void addErrorMessage(java.lang.String strMessage)

Add new nonspecific message to the list of error messages.

Parameters:

strMessage - - message to add

addMessage

public void addMessage(java.lang.Object messageCategory,
                       java.lang.String strMessage)

Add new message for a specific category. The category can represent for example dialog control for which the error message applies or one of the constants defined in this class.

Parameters:

messageCategory - - category to which the message should be added

strMessage - - message to add

addMessages

public void addMessages(Messages erMessages)

Method to merge Messages

Parameters:

erMessages - - Messages to add

getAllErrorMessages

public java.util.List getAllErrorMessages()

Returns list of all error messages.

Returns:

List - list containing all error messages, may be null

getAllMessages

public java.util.List getAllMessages()

Returns list of all messages.

Returns:

List - list containing all messages, may be null

getInfoMessages

public java.util.List getInfoMessages()

Returns list of all info messages.

Returns:

List - list containing all info messages, may be null

getNonSpecificMessages

public java.util.List getNonSpecificMessages()

Returns list of all nonspecific messages.

Returns:

List - list containing nonspecific messages, may be null

getAllErrorMessages

public java.lang.String getAllErrorMessages(java.lang.String strDeliminer)

Returns String with all messages divided by deliminer.

Parameters:

strDeliminer - - deliminer String

Returns:

String - String containing messages for divided by deliminer, may be empty

getMessages

public java.util.List getMessages(java.lang.Object messageCategory)

Returns list of all messages for a given category.

Parameters:

messageCategory - - messages for given category

Returns:

List - list containing messages for given category, may be null

getMessages

public java.lang.String getMessages(java.lang.Object messageCategory,
                                    java.lang.String strDeliminer)

Returns String with all messages for a given category divided by deliminer.

Parameters:

messageCategory - - messages for given category

strDeliminer - - deliminer String

Returns:

String - String containing messages for given category divided by deliminer , may be empty