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

Field Summary

Fields inherited from interface org.sakaiproject.signup.logic.SignupMessageTypes

SEND_EMAIL_ALL_PARTICIPANTS, SEND_EMAIL_ONLY_ORGANIZER_COORDINATORS, SEND_EMAIL_ONLY_SIGNED_UP_ATTENDEES, SIGNUP_ATTENDEE_CANCEL, SIGNUP_ATTENDEE_PROMOTE, SIGNUP_ATTENDEE_SIGNUP, SIGNUP_ATTENDEE_SIGNUP_MOVE, SIGNUP_ATTENDEE_SIGNUP_REPLACE, SIGNUP_ATTENDEE_SIGNUP_SWAP, SIGNUP_CANCEL_MEETING, SIGNUP_MEETING_MODIFIED, SIGNUP_NEW_MEETING, SIGNUP_ORGANIZER_ADD, SIGNUP_ORGANIZER_REMOVE, SIGNUP_PRE_ASSIGN

Method Summary

Methods

Modifier and Type	Method and Description
void	sendCancellationEmail(SignupEventTrackingInfo signupEventTrackingInfo) 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
void	sendEmailAllUsers(SignupMeeting meeting, String messageType) This send email event/meeting informaiotn to all related participants according to the message type
void	sendEmailToAttendee(SignupEventTrackingInfo signupEventTrackingInfo) Send email to attendee when they sign up/cancel their attendance
void	sendEmailToOrganizer(SignupEventTrackingInfo signupEventTrackingInfo) Attend will send an email to organizer when he/she sign up
void	sendEmailToParticipantsByOrganizerAction(SignupEventTrackingInfo signupEventTrackingInfo) This will send email to participants by organizer

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