Package 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
Modifier and TypeMethodDescriptionReturns a String that will be appeneded to the standard email body.Returns a String that will be appended to the standard email subject.Gets the RouteHeaderVO bean which has document datavoidsetActionRequestVO(ActionRequest actionRequestVO) voidsetRouteHeaderVO(Document routeHeaderVO)
-
Method Details
-
getCustomEmailSubject
Returns a String that will be appended to the standard email subject.- Throws:
Exception
-
getCustomEmailBody
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
-
getActionRequestVO
ActionRequest getActionRequestVO() -
setActionRequestVO
-