Class MembershipLeaveUserNotificationBuilder

  • All Implemented Interfaces:
    org.silverpeas.core.notification.user.builder.UserNotificationBuilder

    public class MembershipLeaveUserNotificationBuilder
    extends AbstractCommunityUserNotificationBuilder
    User notification dedicated to the membership leave.
    Author:
    silveryocha
    • Constructor Detail

      • MembershipLeaveUserNotificationBuilder

        protected MembershipLeaveUserNotificationBuilder​(CommunityOfUsers resource)
    • Method Detail

      • memberLeavingIs

        public MembershipLeaveUserNotificationBuilder memberLeavingIs​(org.silverpeas.core.admin.user.model.User leavingMember)
        Indicating the member which is leaving the community.
        Parameters:
        leavingMember - a User instance representing the member leaving the community.
        Returns:
        the builder instance itself.
      • andMessage

        public MembershipLeaveUserNotificationBuilder andMessage​(String message)
        Sets an additional message that allows the member to explain more precisely the reason of its leaving.
        Parameters:
        message - a string.
        Returns:
        the builder instance itself.
      • andContactInFuture

        public MembershipLeaveUserNotificationBuilder andContactInFuture​(boolean contactInFuture)
        Indicates that the member accepts or not to be contacted in the future about its leaving.
        Parameters:
        contactInFuture - a boolean.
        Returns:
        the builder instance itself.
      • getBundleSubjectKey

        protected String getBundleSubjectKey()
        Overrides:
        getBundleSubjectKey in class org.silverpeas.core.notification.user.builder.AbstractTemplateUserNotificationBuilder<CommunityOfUsers>
      • getTemplateFileName

        protected String getTemplateFileName()
        Specified by:
        getTemplateFileName in class org.silverpeas.core.notification.user.builder.AbstractTemplateUserNotificationBuilder<CommunityOfUsers>
      • getTitle

        protected String getTitle​(String language)
        Overrides:
        getTitle in class org.silverpeas.core.notification.user.builder.AbstractTemplateUserNotificationBuilder<CommunityOfUsers>
      • getUserIdsToNotify

        protected Collection<String> getUserIdsToNotify()
        Specified by:
        getUserIdsToNotify in class org.silverpeas.core.notification.user.builder.AbstractUserNotificationBuilder
      • getGroupIdsToNotify

        protected Collection<String> getGroupIdsToNotify()
        Overrides:
        getGroupIdsToNotify in class org.silverpeas.core.notification.user.builder.AbstractUserNotificationBuilder
      • perform

        protected void perform​(CommunityOfUsers resource)
        Overrides:
        perform in class org.silverpeas.core.notification.user.builder.AbstractTemplateUserNotificationBuilder<CommunityOfUsers>