Package org.silverpeas.core.reminder

Class DefaultContributionReminderUserNotification

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

org.silverpeas.core.reminder.DefaultContributionReminderUserNotification

All Implemented Interfaces:

UserNotificationBuilder, FallbackToCoreTemplatePathBehavior

public class DefaultContributionReminderUserNotification
extends AbstractContributionTemplateUserNotificationBuilder<Contribution>
implements FallbackToCoreTemplatePathBehavior

Author:

silveryocha

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	DefaultContributionReminderUserNotification(Reminder reminder)

Method Summary

Modifier and Type	Method	Description
protected Temporal	computeReminderContributionEnd()
protected Temporal	computeReminderContributionStart()
protected NotifAction	getAction()	Gets the type of action on the resource concerned by the notification if any.
protected String	getBundleSubjectKey()	The title is built by AbstractTemplateUserNotificationBuilder.getTitle()
protected User	getReceiver()
protected Temporal	getScheduledDateTimeWithZeroDuration()
protected String	getSender()	Gets the sender (the user identifier usually)
protected String	getTemplateFileName()	Gets the fileName of StringTemplate
protected String	getTemplatePath()	Gets the string template path
protected Collection<String>	getUserIdsToNotify()	A collection of user identifiers.
protected ZoneId	getZoneIdForNormalization()	Gets the ZoneId instance which must have to be used in date normalization.
protected boolean	isSendImmediately()	Is the notification to build has to be sent immediately?
protected Temporal	normalizeTemporal(Temporal temporal)	Normalizes the temporal for user notification according to the result of getZoneIdForNormalization() method.
protected void	performTemplateData(Contribution localizedContribution, SilverpeasTemplate template)	Performs additional template data.

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

getComponentInstanceId, getSenderName, performNotificationResource, performTemplateData

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

createNotification, getContributionAccessLinkLabelBundleKey, getTitle, getTitle, perform, performBuild, performNotificationResource, performNotificationResource

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultContributionReminderUserNotification

protected DefaultContributionReminderUserNotification(Reminder reminder)

Method Detail

computeReminderContributionStart

protected Temporal computeReminderContributionStart()

computeReminderContributionEnd

protected Temporal computeReminderContributionEnd()

getScheduledDateTimeWithZeroDuration

protected Temporal getScheduledDateTimeWithZeroDuration()

getZoneIdForNormalization

protected ZoneId getZoneIdForNormalization()

Gets the ZoneId instance which must have to be used in date normalization.

Returns:

a ZoneId instance.

normalizeTemporal

protected Temporal normalizeTemporal(Temporal temporal)

Normalizes the temporal for user notification according to the result of getZoneIdForNormalization() method.

Parameters:

temporal - a temporal.

Returns:

a LocalDate or ZonedDateTime.

getReceiver

protected User getReceiver()

getBundleSubjectKey

protected String getBundleSubjectKey()

The title is built by AbstractTemplateUserNotificationBuilder.getTitle()

Overrides:

getBundleSubjectKey in class AbstractTemplateUserNotificationBuilder<Contribution>

Returns:

null value.

performTemplateData

protected void performTemplateData(Contribution localizedContribution,
                                   SilverpeasTemplate template)

Description copied from class: AbstractContributionTemplateUserNotificationBuilder

Performs additional template data.

Following attributes have already been set:

• contribution with instance of LocalizedContribution
• contributionName from the contribution title
• senderName from AbstractContributionTemplateUserNotificationBuilder.getSenderName() method

Overrides:

performTemplateData in class AbstractContributionTemplateUserNotificationBuilder<Contribution>

Parameters:

localizedContribution - the localized contribution.

template - the current localized template.

getTemplateFileName

protected String getTemplateFileName()

Description copied from class: AbstractTemplateUserNotificationBuilder

Gets the fileName of StringTemplate

Specified by:

getTemplateFileName in class AbstractTemplateUserNotificationBuilder<Contribution>

Returns:

the StringTemplate filename

getTemplatePath

protected String getTemplatePath()

Description copied from class: AbstractTemplateUserNotificationBuilder

Gets the string template path

Specified by:

getTemplatePath in class AbstractTemplateUserNotificationBuilder<Contribution>

Returns:

the StringTemplate file path

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.

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.

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:

isSendImmediately

protected boolean isSendImmediately()

Description copied from class: AbstractUserNotificationBuilder

Is the notification to build has to be sent immediately? If no, then its sending will be delayed according to the preferences of the users.

Overrides:

isSendImmediately in class AbstractResourceUserNotificationBuilder<Contribution>

Returns:

true if the notification to build has to be sent immediately.