org.sakaiproject.signup.logic.messages

Class SignupEmailBase

java.lang.Object

org.sakaiproject.signup.logic.messages.SignupEmailBase

All Implemented Interfaces:

SignupEmailNotification, MeetingTypes

Direct Known Subclasses:

AllUsersEmailBase, AttendeeCancellationOwnEmail, AttendeeEmailBase, AttendeeModifiedCommentEmail, AutoReminderEmail, CancellationEmail, OrganizerEmailBase, TransferEmailBase

public abstract class SignupEmailBase
extends Object
implements SignupEmailNotification, MeetingTypes

This is a abstract base class for Signup Email. It provides some must-have or common used methods like getFooter()

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cancellation Indicates whether the email represents a cancellation - to be overwritten by subclasses
protected SignupMeeting	meeting
protected boolean	modifyComment
static String	newline
protected static ResourceLoader	rb
static String	space

Fields inherited from interface org.sakaiproject.signup.model.MeetingTypes

ANNOUNCEMENT, BIWEEKLY, CUSTOM_TIMESLOTS, DAILY, GROUP, INDIVIDUAL, ONCE_ONLY, WEEKDAYS, WEEKLY

Constructor Summary

Constructors

Constructor and Description
SignupEmailBase()

Method Summary

Modifier and Type	Method and Description
protected List<net.fortuna.ical4j.model.component.VEvent>	eventsWhichUserIsAttending(User user)
protected String	getAbbreviatedMeetingTitle()
protected String	getFooter(String newline)
protected String	getFooter(String newline, String targetSiteId)
abstract String	getFromAddress() get the from address for this email
abstract List<String>	getHeader() get the email Header, which contains destination email address, subject etc.
abstract String	getMessage() get the main message for this email
protected String	getRepeatTypeMessage(SignupMeeting meeting)
protected String	getServerFromAddress()
protected String	getServiceName()
protected String	getShortSiteTitle(String targetSiteId)
protected String	getShortSiteTitleWithQuote(String targetSiteId)
protected String	getSiteAccessUrl()
protected String	getSiteAccessUrl(String targetSiteId)
protected String	getSiteId() get current site Id
protected String	getSiteTitle()
protected String	getSiteTitle(String targetSiteId)
protected String	getSiteTitleWithQuote()
protected String	getSiteTitleWithQuote(String targetSiteId)
abstract String	getSubject() get the subject for this email
protected Time	getTime(Date date) This will convert the Java date object to a Sakai's Time object, which provides all the useful methods for output.
boolean	isCancellation()
boolean	isModifyComment()
protected String	makeFirstCapLetter(String st) Make first letter of the string to Capital letter
void	setModifyComment(boolean modifyComment)
protected boolean	userIsAttendingTimeslot(User user, SignupTimeslot timeslot)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.sakaiproject.signup.logic.messages.SignupEmailNotification

generateEvents, getMeeting

Field Detail

meeting

protected SignupMeeting meeting

rb

protected static ResourceLoader rb

newline

public static final String newline

See Also:

Constant Field Values

space

public static final String space

See Also:

Constant Field Values

cancellation

protected boolean cancellation

Indicates whether the email represents a cancellation - to be overwritten by subclasses

modifyComment

protected boolean modifyComment

Constructor Detail

SignupEmailBase

public SignupEmailBase()

Method Detail

getFooter

protected String getFooter(String newline)

getFooter

protected String getFooter(String newline,
                           String targetSiteId)

getHeader

public abstract List<String> getHeader()

get the email Header, which contains destination email address, subject etc.

Specified by:

getHeader in interface SignupEmailNotification

getMessage

public abstract String getMessage()

get the main message for this email

Specified by:

getMessage in interface SignupEmailNotification

getFromAddress

public abstract String getFromAddress()

get the from address for this email

Specified by:

getFromAddress in interface SignupEmailNotification

getSubject

public abstract String getSubject()

get the subject for this email

Specified by:

getSubject in interface SignupEmailNotification

getSiteId

protected String getSiteId()

get current site Id

Returns:

the current site Id

getSiteTitle

protected String getSiteTitle()

getSiteTitle

protected String getSiteTitle(String targetSiteId)

getShortSiteTitle

protected String getShortSiteTitle(String targetSiteId)

getSiteTitleWithQuote

protected String getSiteTitleWithQuote()

getSiteTitleWithQuote

protected String getSiteTitleWithQuote(String targetSiteId)

getShortSiteTitleWithQuote

protected String getShortSiteTitleWithQuote(String targetSiteId)

getSiteAccessUrl

protected String getSiteAccessUrl()

getSiteAccessUrl

protected String getSiteAccessUrl(String targetSiteId)

getAbbreviatedMeetingTitle

protected String getAbbreviatedMeetingTitle()

getTime

protected Time getTime(Date date)

This will convert the Java date object to a Sakai's Time object, which provides all the useful methods for output.

Parameters:

date - a Java Date object.

Returns:

a Sakai's Time object.

makeFirstCapLetter

protected String makeFirstCapLetter(String st)

Make first letter of the string to Capital letter

Parameters:

st - a string value

Returns:

a string with a first capital letter

getServiceName

protected String getServiceName()

getRepeatTypeMessage

protected String getRepeatTypeMessage(SignupMeeting meeting)

getServerFromAddress

protected String getServerFromAddress()

userIsAttendingTimeslot

protected boolean userIsAttendingTimeslot(User user,
                                          SignupTimeslot timeslot)

eventsWhichUserIsAttending

protected List<net.fortuna.ical4j.model.component.VEvent> eventsWhichUserIsAttending(User user)

isCancellation

public boolean isCancellation()

Specified by:

isCancellation in interface SignupEmailNotification

isModifyComment

public boolean isModifyComment()

Specified by:

isModifyComment in interface SignupEmailNotification

setModifyComment

public void setModifyComment(boolean modifyComment)