org.ikasan.spec.scheduled.notification.model.EmailNotificationContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ikasan-uber-spec Show documentation
All specifications packaged up in a single uber jar for convenience of use in the Enterprise Integration Platform
The newest version!
package org.ikasan.spec.scheduled.notification.model;

import java.io.Serializable;
import java.util.List;
import java.util.Map;

public interface EmailNotificationContext extends Serializable  {

    /**
     * Get the name of the Context for the notification
     * @return
     */
    String getContextName();

    /**
     * Get the name of the Context for the notification
     * @param contextName
     */
    void setContextName(String contextName);

    /**
     * List of all monitor types that we want listen and send a notification for this context.
     * @return
     */
    List getMonitorTypes();

    /**
     * Set monitorTypes for this context
     * @param monitorTypes
     */
    void setMonitorTypes(List monitorTypes);

    /**
     * List of email address to send to
     * @return
     */
    List getEmailSendTo();

    /** Set email address to send to
     * @param emailSendTo
     */
    void setEmailSendTo(List emailSendTo);

    /**
     * Map of email address to send to for a given monitor type
     * @return
     */
    Map> getEmailSendToByMonitorType();

    /** Map email address to send to by monitor type
     * @param emailSendToByMonitorType
     */
    void setEmailSendToByMonitorType(Map> emailSendToByMonitorType);

    /**
     * List of email address to send to cc
     * @return
     */
    List getEmailSendCc();

    /**
     * Set email address to send to cc
     * @param emailSendCc
     */
    void setEmailSendCc(List emailSendCc);

    /**
     * Map of email address to send to cc for a given monitor type
     * @return
     */
    Map> getEmailSendCcByMonitorType();

    /** Map email address to send to cc by monitor type
     * @param emailSendCcByMonitorType
     */
    void setEmailSendCcByMonitorType(Map> emailSendCcByMonitorType);

    /**
     * List of email address to send to bcc
     * @return
     */
    List getEmailSendBcc();

    /**
     * Set email address to send to bcc
     * @param emailSendBcc
     */
    void setEmailSendBcc(List emailSendBcc);

    /**
     * Map of email address to send to bcc for a given monitor type
     * @return
     */
    Map> getEmailSendBccByMonitorType();

    /** Map email address to send to bcc by monitor type
     * @param emailSendBccByMonitorType
     */
    void setEmailSendBccByMonitorType(Map> emailSendBccByMonitorType);

    /**
     * Get notification templates for subject
     * @return
     */
    Map getEmailSubjectNotificationTemplate();

    /**
     * Set notification templates for subject
     */
    void setEmailSubjectNotificationTemplate(Map emailSubjectNotificationTemplate);

    /**
     * Get notification templates for body
     * @return
     */
    Map getEmailBodyNotificationTemplate();

    /**
     * Set notification templates for subject
     * @param emailBodyNotificationTemplate
     */
    void setEmailBodyNotificationTemplate(Map emailBodyNotificationTemplate);

    /**
     * Get any attachments
     * @return
     */
    String getAttachment();

    /**
     * Set attachments
     * @param attachment
     */
    void setAttachment(String attachment);

    /**
     * Flat to inform to return an html format email
     * @return
     */
    boolean isHtml();

    /**
     * Set true of false to send email as html
     * @param html
     */
    void setHtml(boolean html);
}