org.sakaiproject.signup.logic.messages

Interface SignupEmailNotification

public interface SignupEmailNotification

This is an interface for email

Method Summary

Modifier and Type	Method and Description
List<net.fortuna.ical4j.model.component.VEvent>	generateEvents(User user, SignupCalendarHelper calendarHelper) Generate a list of VEvent objects to be converted to ICal and attached to the email.
String	getFromAddress() Provide the from address.
List<String>	getHeader() provide email header information
SignupMeeting	getMeeting() Add ability to get SignupMeeting that is the parent of this email
String	getMessage() provide email message body
String	getSubject() Provide the subject.
boolean	isCancellation() Does this type of email represent a cancellation?
boolean	isModifyComment() this type means that it will not generate ICS file

Method Detail

getHeader

List<String> getHeader()

provide email header information

Returns:

a list of email header information strings

getMessage

String getMessage()

provide email message body

Returns:

a message body string

getFromAddress

String getFromAddress()

Provide the from address. Cannot always rely on the 'From:' header.

Returns:

the email address

getSubject

String getSubject()

Provide the subject. Cannot always rely on the 'Subject:' header.

Returns:

the subject

getMeeting

SignupMeeting getMeeting()

Add ability to get SignupMeeting that is the parent of this email

Returns:

generateEvents

List<net.fortuna.ical4j.model.component.VEvent> generateEvents(User user,
                                                               SignupCalendarHelper calendarHelper)

Generate a list of VEvent objects to be converted to ICal and attached to the email.

Parameters:

user - The User performing the action

Returns:

The list of events to be attached to this email

isCancellation

boolean isCancellation()

Does this type of email represent a cancellation?

Returns:

true if it is a cancellation, false otherwise

isModifyComment

boolean isModifyComment()

this type means that it will not generate ICS file

Returns: