com.ibm.ecm.event.messages

Class ActionMessage

java.lang.Object

com.ibm.ecm.event.messages.ActionMessage

public class ActionMessage
extends java.lang.Object

This class defines an action message that can contains information can be be used to edit the JSON response being returned to the client

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADMIN_RESPONSE
static java.lang.String	EXPLANATION
static java.lang.String	NUMBER
static java.lang.String	TEXT
static java.lang.String	USER_RESPONSE

Constructor Summary

Constructors

Constructor and Description
ActionMessage(int number, java.lang.String text, java.lang.String explanation, java.lang.String userResponse, java.lang.String adminResponse)
ActionMessage(int number, java.lang.String text, java.lang.String explanation, java.lang.String userResponse, java.lang.String adminResponse, java.lang.Throwable exception) Creates an ActionMessage that holds the current state of com.ibm.ecm.mediator.BaseMediator.Messages, and changes made to it.

Method Summary

Modifier and Type	Method and Description
java.lang.String	adminResponse() returns message admin response
java.util.Map	data() returns modified message
java.lang.Throwable	exception() returns passed exception
java.lang.String	explanation() returns message explanation
boolean	hasChanged() Check whether user or plugin has made changes to the original message passed message
int	number() returns message number
java.lang.String	text() returns message text
void	updateMessage(int number, java.lang.String text, java.lang.String explanation, java.lang.String userResponse, java.lang.String adminResponse) This is used to make and track changes to the message object in focus.
java.lang.String	userResponse() returns message user response

Methods inherited from class java.lang.Object

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

Field Detail

NUMBER

public static final java.lang.String NUMBER

See Also:

Constant Field Values

TEXT

public static final java.lang.String TEXT

See Also:

Constant Field Values

EXPLANATION

public static final java.lang.String EXPLANATION

See Also:

Constant Field Values

USER_RESPONSE

public static final java.lang.String USER_RESPONSE

See Also:

Constant Field Values

ADMIN_RESPONSE

public static final java.lang.String ADMIN_RESPONSE

See Also:

Constant Field Values

Constructor Detail

ActionMessage

public ActionMessage(int number,
                     java.lang.String text,
                     java.lang.String explanation,
                     java.lang.String userResponse,
                     java.lang.String adminResponse,
                     java.lang.Throwable exception)

Creates an ActionMessage that holds the current state of com.ibm.ecm.mediator.BaseMediator.Messages, and changes made to it.

Parameters:

number - The message number

text - The message text

explanation - The message explanation

userResponse - The message user response text

adminResponse - The message admin response text

exception - The exception that occurs, if any data A Map with similar member variable as com.ibm.ecm.mediator.BaseMediator.Messages that holds the changes made by a user via plugin. orig A Map with is an exact copy of the original message passed.

ActionMessage

public ActionMessage(int number,
                     java.lang.String text,
                     java.lang.String explanation,
                     java.lang.String userResponse,
                     java.lang.String adminResponse)

Method Detail

number

public int number()

returns message number

text

public java.lang.String text()

returns message text

explanation

public java.lang.String explanation()

returns message explanation

userResponse

public java.lang.String userResponse()

returns message user response

adminResponse

public java.lang.String adminResponse()

returns message admin response

exception

public java.lang.Throwable exception()

returns passed exception

data

public java.util.Map data()

returns modified message

hasChanged

public boolean hasChanged()

Check whether user or plugin has made changes to the original message passed message

updateMessage

public void updateMessage(int number,
                          java.lang.String text,
                          java.lang.String explanation,
                          java.lang.String userResponse,
                          java.lang.String adminResponse)

This is used to make and track changes to the message object in focus. Update message object by passing updated parameters.