org.kuali.rice.kew.mail

Interface CustomEmailAttribute

All Known Implementing Classes:

CustomEmailAttributeImpl

public interface CustomEmailAttribute

Application areas can implement this interface to generate custom email content. At the point that getCustomEmailSubject() and getCustomEmailBody() are called, the RouteHeaderVO and ActionRequestVO have already been set so the implementing class can simply call the approriate getters to retrieve the data beans.

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
ActionRequest	getActionRequestVO()
String	getCustomEmailBody() Returns a String that will be appeneded to the standard email body.
String	getCustomEmailSubject() Returns a String that will be appended to the standard email subject.
Document	getRouteHeaderVO() Gets the RouteHeaderVO bean which has document data
void	setActionRequestVO(ActionRequest actionRequestVO)
void	setRouteHeaderVO(Document routeHeaderVO)

Method Detail

getCustomEmailSubject

String getCustomEmailSubject()
                             throws Exception

Returns a String that will be appended to the standard email subject.

Throws:

Exception

getCustomEmailBody

String getCustomEmailBody()
                          throws Exception

Returns a String that will be appeneded to the standard email body.

Throws:

Exception

getRouteHeaderVO

Document getRouteHeaderVO()

Gets the RouteHeaderVO bean which has document data

Returns:

setRouteHeaderVO

void setRouteHeaderVO(Document routeHeaderVO)

getActionRequestVO

ActionRequest getActionRequestVO()

setActionRequestVO

void setActionRequestVO(ActionRequest actionRequestVO)