Package org.sakaiproject.signup.logic

Interface SignupEmailFacade

  • All Superinterfaces:
    SignupMessageTypes
    public interface SignupEmailFacade
extends SignupMessageTypes

    This is an interface, which provided methods for Signup tool to send emails out via emailService

    • Method Detail

      • sendEmailAllUsers

        void sendEmailAllUsers​(SignupMeeting meeting,
                       String messageType)
                throws Exception
        This send email event/meeting informaiotn to all related participants according to the message type
        Parameters:
        meeting - a SignupMeeting object
        messageType - a string type, which classifies what type of message, which should be emailed away
        Throws:
        Exception - thrown if something goes bad

      • sendEmailToOrganizer

        void sendEmailToOrganizer​(SignupEventTrackingInfo signupEventTrackingInfo)
                   throws Exception
        Attend will send an email to organizer when he/she sign up
        Parameters:
        signupEventTrackingInfo - an EventTrackingInfo object, which contains all the information about user action such as signup and cancel as well as auto-promotion
        Throws:
        Exception - thrown if something goes bad

      • sendCancellationEmail

        void sendCancellationEmail​(SignupEventTrackingInfo signupEventTrackingInfo)
                    throws Exception
        This sends cancellation email to event/meeting organizer as well as to the people on waiting list, who get promoted due to the attendee's cancellation
        Parameters:
        signupEventTrackingInfo - an EventTrackingInfo object, which contains all the information about user action such as signup and cancel as well as auto-promotion
        Throws:
        Exception - thrown if something goes bad

      • sendEmailToParticipantsByOrganizerAction

        void sendEmailToParticipantsByOrganizerAction​(SignupEventTrackingInfo signupEventTrackingInfo)
                                       throws Exception
        This will send email to participants by organizer
        Parameters:
        signupEventTrackingInfo - an EventTrackingInfo object, which contains all the information about user action such as signup and cancel as well as auto-promotion
        Throws:
        Exception - thrown if something goes bad

      • sendEmailToAttendee

        void sendEmailToAttendee​(SignupEventTrackingInfo signupEventTrackingInfo)
                  throws Exception
        Send email to attendee when they sign up/cancel their attendance
        Parameters:
        eventTrackingInfo - an EventTrackingInfo object, which contains all the information about user action such as signup and cancel
        Throws:
        Exception - thrown if something goes bad

      • sendUpdateCommentEmail

        void sendUpdateCommentEmail​(SignupEventTrackingInfo signupEventTrackingInfo)
                     throws Exception
        Send email to attendee or organizers when they update the comment
        Parameters:
        eventTrackingInfo - an EventTrackingInfo object, which contains all the information about user action such as signup and cancel
        Throws:
        Exception - thrown if something goes bad