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

Class AbstractCalendarUserNotificationBuilder<C extends Contribution>

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<C>

Type Parameters:

C - a contribution implementation type

All Implemented Interfaces:

UserNotificationBuilder, FallbackToCoreTemplatePathBehavior

Direct Known Subclasses:

CalendarEventOccurrenceNotifyUserNotificationBuilder

public abstract class AbstractCalendarUserNotificationBuilder<C extends Contribution>
extends AbstractContributionTemplateUserNotificationBuilder<C>
implements FallbackToCoreTemplatePathBehavior

Centralizes the building of a UserNotification in relation with a calendar contribution.

Be aware about FallbackToCoreTemplatePathBehavior.

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

Modifier	Constructor	Description
protected	AbstractCalendarUserNotificationBuilder(C contribution, User user)

Method Summary

Modifier and Type	Method	Description
protected String	getComponentInstanceId()	Gets the component instance identifier.
protected String	getContributionAccessLinkLabelBundleKey()	Gets the string bundle key for contribution access link
protected String	getLocalizationBundlePath()	Gets the path of the localization bundle to load.
protected String	getSender()	Gets the sender (the user identifier usually)
protected String	getTemplatePath()	Gets the string template path
protected void	perform(C resource)

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, getTemplateFileName, 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, getAction, getBundle, getBundle, getContent, getExternalAddressesToNotify, getGroupIdsToNotify, getMessageType, getNotificationMetaData, getUserIdsToExcludeFromNotifying, getUserIdsToNotify, stop, stopWhenNoUserToNotify

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCalendarUserNotificationBuilder

protected AbstractCalendarUserNotificationBuilder(C contribution,
                                                  User user)

Method Detail

perform

protected void perform(C resource)

Overrides:

perform in class AbstractTemplateUserNotificationBuilder<C extends Contribution>

getTemplatePath

protected String getTemplatePath()

Description copied from class: AbstractTemplateUserNotificationBuilder

Gets the string template path

Specified by:

getTemplatePath in class AbstractTemplateUserNotificationBuilder<C extends Contribution>

Returns:

the StringTemplate file path

getComponentInstanceId

protected String getComponentInstanceId()

Description copied from class: AbstractUserNotificationBuilder

Gets the component instance identifier.

Overrides:

getComponentInstanceId in class AbstractContributionTemplateUserNotificationBuilder<C extends Contribution>

Returns:

the unique identifier of the component instance concerned by the notification to build.

getSender

protected String getSender()

Description copied from class: AbstractUserNotificationBuilder

Gets the sender (the user identifier usually)

Specified by:

getSender in class AbstractUserNotificationBuilder

Returns:

the unique identifier of the sender.

getLocalizationBundlePath

protected String getLocalizationBundlePath()

Description copied from class: AbstractUserNotificationBuilder

Gets the path of the localization bundle to load. By default, returns the general translations. For more specific localized text to use in the notification, override this method.

Overrides:

getLocalizationBundlePath in class AbstractUserNotificationBuilder

Returns:

the path of the localization bundle.

getContributionAccessLinkLabelBundleKey

protected String getContributionAccessLinkLabelBundleKey()

Description copied from class: AbstractTemplateUserNotificationBuilder

Gets the string bundle key for contribution access link

Overrides:

getContributionAccessLinkLabelBundleKey in class AbstractTemplateUserNotificationBuilder<C extends Contribution>

Returns:

the string bundle key.