org.silverpeas.publication.dateReminder.notification
Class PublicationDateReminderUserNotification

java.lang.Object
  com.silverpeas.notification.builder.AbstractUserNotificationBuilder
      com.silverpeas.notification.builder.AbstractResourceUserNotificationBuilder<T>
          com.silverpeas.notification.builder.AbstractTemplateUserNotificationBuilder<PersistentResourceDateReminder>
              org.silverpeas.publication.dateReminder.notification.PublicationDateReminderUserNotification

All Implemented Interfaces:

UserNotificationBuilder

public class PublicationDateReminderUserNotification
extends AbstractTemplateUserNotificationBuilder<PersistentResourceDateReminder>

Set parameters for user notifications sended automatically for date reminder.

Author:

Cécile Bonin

Constructor Summary

PublicationDateReminderUserNotification(PersistentResourceDateReminder resourceDateReminder, ResourceLocator componentMessages)

Method Summary

protected SilverpeasTemplate	createTemplate() Creates the template bases
protected NotifAction	getAction() Gets the type of action on a resource
protected String	getBundleSubjectKey()
protected String	getComponentInstanceId() Gets the component instance id
protected String	getContributionAccessLinkLabelBundleKey() Gets the string bundle key for contribution access link
protected String	getMultilangPropertyFile() Gets the resource locator path
protected String	getResourceURL(PersistentResourceDateReminder resource) Gets the URL of the resource
protected String	getSender() Gets the sender (the user id usually)
protected String	getTemplatePath() Gets the string template path
protected Collection<String>	getUserIdsToNotify()
protected void	performNotificationResource(String language, PersistentResourceDateReminder resource, NotificationResourceData notificationResourceData) Builds the notification resource data container from a given language.
protected void	performTemplateData(String language, PersistentResourceDateReminder resource, SilverpeasTemplate template) Performing notification data from a given language

Methods inherited from class com.silverpeas.notification.builder.AbstractTemplateUserNotificationBuilder

createNotification, getFileName, getTitle, perform, performBuild, performNotificationResource, performNotificationResource

Methods inherited from class com.silverpeas.notification.builder.AbstractResourceUserNotificationBuilder

getResource, initialize, initializeNotificationResourceData, isSendImmediatly, performBuild, setResource

Methods inherited from class com.silverpeas.notification.builder.AbstractUserNotificationBuilder

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PublicationDateReminderUserNotification

public PublicationDateReminderUserNotification(PersistentResourceDateReminder resourceDateReminder,
                                               ResourceLocator componentMessages)

Method Detail

getBundleSubjectKey

protected String getBundleSubjectKey()

Specified by:

getBundleSubjectKey in class AbstractTemplateUserNotificationBuilder<PersistentResourceDateReminder>

getUserIdsToNotify

protected Collection<String> getUserIdsToNotify()

Specified by:

getUserIdsToNotify in class AbstractUserNotificationBuilder

performTemplateData

protected void performTemplateData(String language,
                                   PersistentResourceDateReminder resource,
                                   SilverpeasTemplate template)

Description copied from class: AbstractTemplateUserNotificationBuilder

Performing notification data from a given language

Specified by:

performTemplateData in class AbstractTemplateUserNotificationBuilder<PersistentResourceDateReminder>

performNotificationResource

protected void performNotificationResource(String language,
                                           PersistentResourceDateReminder resource,
                                           NotificationResourceData notificationResourceData)

Description copied from class: AbstractTemplateUserNotificationBuilder

Builds the notification resource data container from a given language. Don't forget to fill resourceId, resourceType, resourceName, resourceDescription (optional), resourceLocation (optional). If ResourceLocation is empty , it will be filled by the NotificationManager with the given componentInstanceId of NotificationMetaData

Specified by:

performNotificationResource in class AbstractTemplateUserNotificationBuilder<PersistentResourceDateReminder>

createTemplate

protected SilverpeasTemplate createTemplate()

Description copied from class: AbstractTemplateUserNotificationBuilder

Creates the template bases

Overrides:

createTemplate in class AbstractTemplateUserNotificationBuilder<PersistentResourceDateReminder>

Returns:

getResourceURL

protected String getResourceURL(PersistentResourceDateReminder resource)

Description copied from class: AbstractResourceUserNotificationBuilder

Gets the URL of the resource

Overrides:

getResourceURL in class AbstractResourceUserNotificationBuilder<PersistentResourceDateReminder>

Returns:

getTemplatePath

protected String getTemplatePath()

Description copied from class: AbstractTemplateUserNotificationBuilder

Gets the string template path

Specified by:

getTemplatePath in class AbstractTemplateUserNotificationBuilder<PersistentResourceDateReminder>

Returns:

getAction

protected NotifAction getAction()

Description copied from class: AbstractUserNotificationBuilder

Gets the type of action on a resource

Specified by:

getAction in class AbstractUserNotificationBuilder

Returns:

getComponentInstanceId

protected String getComponentInstanceId()

Description copied from class: AbstractUserNotificationBuilder

Gets the component instance id

Specified by:

getComponentInstanceId in class AbstractUserNotificationBuilder

Returns:

getSender

protected String getSender()

Description copied from class: AbstractUserNotificationBuilder

Gets the sender (the user id usually)

Specified by:

getSender in class AbstractUserNotificationBuilder

Returns:

getMultilangPropertyFile

protected String getMultilangPropertyFile()

Description copied from class: AbstractUserNotificationBuilder

Gets the resource locator path

Overrides:

getMultilangPropertyFile in class AbstractUserNotificationBuilder

Returns:

getContributionAccessLinkLabelBundleKey

protected String getContributionAccessLinkLabelBundleKey()

Description copied from class: AbstractTemplateUserNotificationBuilder

Gets the string bundle key for contribution access link

Overrides:

getContributionAccessLinkLabelBundleKey in class AbstractTemplateUserNotificationBuilder<PersistentResourceDateReminder>

Returns: