Package org.silverpeas.core.calendar.notification.user

Class CalendarEventOccurrenceNotifyUserNotificationBuilder

java.lang.Object

org.silverpeas.core.notification.user.builder.AbstractUserNotificationBuilder

org.silverpeas.core.notification.user.builder.AbstractResourceUserNotificationBuilder<T>

org.silverpeas.core.notification.user.builder.AbstractTemplateUserNotificationBuilder<C>

org.silverpeas.core.notification.user.builder.AbstractContributionTemplateUserNotificationBuilder<C>

org.silverpeas.core.calendar.notification.user.AbstractCalendarUserNotificationBuilder<CalendarEventOccurrence>

org.silverpeas.core.calendar.notification.user.CalendarEventOccurrenceNotifyUserNotificationBuilder

All Implemented Interfaces:

UserNotificationBuilder, FallbackToCoreTemplatePathBehavior

public class CalendarEventOccurrenceNotifyUserNotificationBuilder
extends AbstractCalendarUserNotificationBuilder<CalendarEventOccurrence>

The centralization of the construction of the calendar occurrence notifications

Author:

Yohann Chastagnier

Nested Class Summary

Nested classes/interfaces inherited from class org.silverpeas.core.notification.user.builder.AbstractTemplateUserNotificationBuilder

AbstractTemplateUserNotificationBuilder.NotificationTemporal

Field Summary

Fields inherited from class org.silverpeas.core.notification.user.builder.AbstractTemplateUserNotificationBuilder

CUSTOM_NOTIFICATION_SUBJECT, DEFAULT_NOTIFICATION_SUBJECT

Constructor Summary

Constructors

Constructor	Description
CalendarEventOccurrenceNotifyUserNotificationBuilder(CalendarEventOccurrence occurrence, User user)

Method Summary

Modifier and Type	Method	Description
protected NotifAction	getAction()	Gets the type of action on the resource concerned by the notification if any.
protected String	getTemplateFileName()	Gets the fileName of StringTemplate
protected Collection<String>	getUserIdsToNotify()	A collection of user identifiers.
protected boolean	stopWhenNoUserToNotify()	Should the notification treatment be stopped if there is no user to notify?

Methods inherited from class org.silverpeas.core.calendar.notification.user.AbstractCalendarUserNotificationBuilder

getComponentInstanceId, getContributionAccessLinkLabelBundleKey, getLocalizationBundlePath, getSender, getTemplatePath, perform

Methods inherited from class org.silverpeas.core.notification.user.builder.AbstractContributionTemplateUserNotificationBuilder

getSenderName, performNotificationResource, performTemplateData, performTemplateData

Methods inherited from class org.silverpeas.core.notification.user.builder.AbstractTemplateUserNotificationBuilder

createNotification, getBundleSubjectKey, getTitle, getTitle, performBuild, performNotificationResource, performNotificationResource

Methods inherited from class org.silverpeas.core.notification.user.builder.AbstractResourceUserNotificationBuilder

getResource, getResourceURL, initialize, initializeNotificationResourceData, isGroupCanBeNotified, isSendImmediately, isUserCanBeNotified, performBuild, setResource

Methods inherited from class org.silverpeas.core.notification.user.builder.AbstractUserNotificationBuilder

build, getBundle, getBundle, getContent, getExternalAddressesToNotify, getGroupIdsToNotify, getMessageType, getNotificationMetaData, getUserIdsToExcludeFromNotifying, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

CalendarEventOccurrenceNotifyUserNotificationBuilder

public CalendarEventOccurrenceNotifyUserNotificationBuilder(CalendarEventOccurrence occurrence,
                                                            User user)

Method Detail

getUserIdsToNotify

protected Collection<String> getUserIdsToNotify()

Description copied from class: AbstractUserNotificationBuilder

A collection of user identifiers. All the users in this collection will be notified. This method requires to be implemented.

Specified by:

getUserIdsToNotify in class AbstractUserNotificationBuilder

Returns:

getAction

protected NotifAction getAction()

Description copied from class: AbstractUserNotificationBuilder

Gets the type of action on the resource concerned by the notification if any.

Specified by:

getAction in class AbstractUserNotificationBuilder

Returns:

a value of the NotifAction enumeration.

stopWhenNoUserToNotify

protected boolean stopWhenNoUserToNotify()

Description copied from class: AbstractUserNotificationBuilder

Should the notification treatment be stopped if there is no user to notify? By default true. This method can be overridden to specify a different or a contextualized answer. In that case, the recipients setting should be then performed out of the builder.

Overrides:

stopWhenNoUserToNotify in class AbstractUserNotificationBuilder

Returns:

true if no notification has to be done when no recipient is defined.

getTemplateFileName

protected String getTemplateFileName()

Description copied from class: AbstractTemplateUserNotificationBuilder

Gets the fileName of StringTemplate

Specified by:

getTemplateFileName in class AbstractTemplateUserNotificationBuilder<CalendarEventOccurrence>

Returns:

the StringTemplate filename