org.kuali.rice.krad.uif.util

Class KeyMessage

java.lang.Object

org.kuali.rice.core.api.util.AbstractKeyValue

org.kuali.rice.krad.uif.util.KeyMessage

All Implemented Interfaces:

Serializable, KeyValue

public class KeyMessage
extends AbstractKeyValue

KeyMessage object for key-value pairs that contain rich content in the value portion. By translating this content to message, the content will be parsed and replaced appropriately for KeyValue controls.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.core.api.util.AbstractKeyValue

disabled, key, value

Constructor Summary

Constructors

Constructor and Description
KeyMessage(String key, String value, Message message) Constructor for KeyMessage
KeyMessage(String key, String value, Message message, boolean disabled) Constructor for KeyMessage

Method Summary

Modifier and Type	Method and Description
Message	getMessage() Get the message.
void	setKey(String key) Set the key
void	setMessage(Message message) Set the message.
void	setValue(String value) Set the value

Methods inherited from class org.kuali.rice.core.api.util.AbstractKeyValue

getKey, getValue, isDisabled, setDisabled

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyMessage

public KeyMessage(String key,
                  String value,
                  Message message)

Constructor for KeyMessage

Parameters:

key - key

value - value

message - message with messageText set to value

KeyMessage

public KeyMessage(String key,
                  String value,
                  Message message,
                  boolean disabled)

Constructor for KeyMessage

Parameters:

key - key

value - value

message - message with messageText set to value

disabled - boolean whether to enable the key/value or not

Method Detail

setKey

public void setKey(String key)

Set the key

Parameters:

key -

setValue

public void setValue(String value)

Set the value

Parameters:

value -

getMessage

public Message getMessage()

Get the message. The message will contain the translated/parsed value after its lifecycle executes.

Returns:

message with translated structure

setMessage

public void setMessage(Message message)

Set the message. The message should have the rich message value as its messageText

Parameters:

message -