org.kuali.kra.common.notification

Class NotificationRendererBase

java.lang.Object

org.kuali.kra.common.notification.NotificationRendererBase

All Implemented Interfaces:

Serializable, NotificationRenderer

Direct Known Subclasses:

AwardNotificationRenderer, CoiNotificationRenderer, CommitteeNotificationRenderer, CommitteeNotificationRenderer, InstitutionalProposalNotificationRenderer, NegotiationNotificationRenderer, ProposalDevelopmentNotificationRenderer, ProtocolNotificationRendererBase, SubAwardNotificationRenderer

public abstract class NotificationRendererBase
extends Object
implements NotificationRenderer, Serializable

Defines a base class for rendering Notification messages.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	APP_LINK_PREFIX
static String	APPLICATION_URL_PARM
static String	DOCHANDLER_PREFIX
static String	RICE_SERVER_URL
static String	USER_FULLNAME

Constructor Summary

Constructors

Constructor and Description
NotificationRendererBase()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getDefaultReplacementParameters() Returns the default replacement parameters for the renderer.
KcPersonService	getKcPersonService()
protected String	getSafeMessage(String key, String message)
String	render(String text) Renders the message in text using default replacement parameters.
protected String	render(String text, Map<String,String> replacementParameters) Renders the text based on the given default parameters.
void	setKcPersonService(KcPersonService kcPersonService)

Methods inherited from class java.lang.Object

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

Field Detail

USER_FULLNAME

public static final String USER_FULLNAME

See Also:

Constant Field Values

DOCHANDLER_PREFIX

public static final String DOCHANDLER_PREFIX

See Also:

Constant Field Values

RICE_SERVER_URL

public static final String RICE_SERVER_URL

See Also:

Constant Field Values

APP_LINK_PREFIX

public static final String APP_LINK_PREFIX

See Also:

Constant Field Values

APPLICATION_URL_PARM

public static final String APPLICATION_URL_PARM

See Also:

Constant Field Values

Constructor Detail

NotificationRendererBase

public NotificationRendererBase()

Method Detail

render

public String render(String text)

Renders the message in text using default replacement parameters.

Specified by:

render in interface NotificationRenderer

Parameters:

text - the message to be rendered

Returns:

the message with all possible search and replace parameters filled in

See Also:

NotificationRenderer.render(java.lang.String)

render

protected String render(String text,
            Map<String,String> replacementParameters)

Renders the text based on the given default parameters.

Parameters:

text - the message to be rendered

replacementParameters - the parameters to replace in the message

Returns:

the message with all the possible search and replace

getDefaultReplacementParameters

public Map<String,String> getDefaultReplacementParameters()

Returns the default replacement parameters for the renderer.

Specified by:

getDefaultReplacementParameters in interface NotificationRenderer

Returns:

the default replacement parameters for the renderer

See Also:

org.kuali.kra.common.notification.NotificationRenderer#getReplacementParameters()

getKcPersonService

public KcPersonService getKcPersonService()

setKcPersonService

public void setKcPersonService(KcPersonService kcPersonService)

getSafeMessage

protected String getSafeMessage(String key,
                    String message)