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 Type
    Method
    Description
    org.kuali.rice.kew.api.action.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.
    org.kuali.rice.kew.api.document.Document
    getRouteHeaderVO()
    Gets the RouteHeaderVO bean which has document data
    void
    setActionRequestVO(org.kuali.rice.kew.api.action.ActionRequest actionRequestVO)
     
    void
    setRouteHeaderVO(org.kuali.rice.kew.api.document.Document routeHeaderVO)
     

  • Method Details

    • 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

      org.kuali.rice.kew.api.document.Document getRouteHeaderVO()
      Gets the RouteHeaderVO bean which has document data
      Returns:

    • setRouteHeaderVO

      void setRouteHeaderVO(org.kuali.rice.kew.api.document.Document routeHeaderVO)

    • getActionRequestVO

      org.kuali.rice.kew.api.action.ActionRequest getActionRequestVO()

    • setActionRequestVO

      void setActionRequestVO(org.kuali.rice.kew.api.action.ActionRequest actionRequestVO)