oracle.alm.common.message
Class AlmMessageFactory

java.lang.Object
  oracle.alm.common.message.AlmMessageFactory

public class AlmMessageFactory
extends java.lang.Object

The AlmMessageFactory is the factory class for maintaining a AlmMessage list for a specific messageId. It is used together with AlmMessage, ClientRequestContext to provide TPC connector a solution for showing message logged in TPC connector code to end user through TPC IDE client. Please refer to ClientRequestContext for example.

Since:

11.1.1.1.0

See Also:

AlmMessage, ClientRequestContext

Method Summary

void	addMessage(java.lang.String messageId, AlmMessage message) Adds a message to the message list specified by the messageId.
java.util.Set<java.lang.String>	getMessageIds() Retrieves all message sources identified by message Ids
java.util.List<AlmMessage>	getMessages(java.util.Locale locale, java.lang.String messageId, java.lang.Object[] params) Returns a message list specified by message id
java.util.List<AlmMessage>	getMessages(java.lang.String messageId, java.lang.Object[] params)
static AlmMessageFactory	newInstance() Creates a new instance of AlmMessageFactory.

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static AlmMessageFactory newInstance()

Creates a new instance of AlmMessageFactory.

Returns:

An instance of AlmMessageFactory

getMessages

public java.util.List<AlmMessage> getMessages(java.lang.String messageId,
                                              java.lang.Object[] params)

Parameters:

messageId - Holds all messages related to specific source object.

params - (not supported at this time)

Returns:

message list for a specific messageId.

getMessages

public java.util.List<AlmMessage> getMessages(java.util.Locale locale,
                                              java.lang.String messageId,
                                              java.lang.Object[] params)

Returns a message list specified by message id

Parameters:

locale - the locale of message applied (not supported at this time)

messageId - the message id of the message list

params - (not supported at this time)

Returns:

A list of AlmMessage

addMessage

public void addMessage(java.lang.String messageId,
                       AlmMessage message)

Adds a message to the message list specified by the messageId.

Parameters:

messageId - messageId

message - message object

getMessageIds

public java.util.Set<java.lang.String> getMessageIds()

Retrieves all message sources identified by message Ids

Returns:

A list of message sources identified by message Ids