FormsOnlinePendingValidationRequestUserNotification.java

/*
 * Copyright (C) 2000 - 2024 Silverpeas
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * As a special exception to the terms and conditions of version 3.0 of
 * the GPL, you may redistribute this Program in connection with Free/Libre
 * Open Source Software ("FLOSS") applications as described in Silverpeas's
 * FLOSS exception.  You should have recieved a copy of the text describing
 * the FLOSS exception, and it is also available here:
 * "https://www.silverpeas.org/legal/floss_exception.html"
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
package org.silverpeas.components.formsonline.notification;

import org.silverpeas.components.formsonline.model.FormInstance;
import org.silverpeas.components.formsonline.model.FormInstanceValidation;
import org.silverpeas.core.notification.user.client.constant.NotifAction;

import java.util.Collection;
import java.util.List;

import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;

/**
 * @author Nicolas EYSSERIC
 */
public class FormsOnlinePendingValidationRequestUserNotification
    extends FormsOnlineValidationRequestUserNotification {

  private final List<String> usersToBeNotified;
  private final List<String> groupsToBeNotified;

  public FormsOnlinePendingValidationRequestUserNotification(final FormInstance resource) {
    super(resource, NotifAction.PENDING_VALIDATION);
    final FormInstanceValidation pendingValidation = resource.getPendingValidation();
    if (pendingValidation != null) {
      if (pendingValidation.getValidationType().isHierarchical()) {
        // notify boss
        final String bossId = resource.getForm().getHierarchicalValidatorOfCurrentUser();
        this.usersToBeNotified = singletonList(bossId);
        this.groupsToBeNotified = emptyList();
      } else if (pendingValidation.getValidationType().isIntermediate()) {
        this.usersToBeNotified = extractUserIds(resource.getForm().getIntermediateReceiversAsUsers());
        this.groupsToBeNotified = extractGroupIds(resource.getForm().getIntermediateReceiversAsGroups());
      } else {
        this.usersToBeNotified = extractUserIds(resource.getForm().getReceiversAsUsers());
        this.groupsToBeNotified = extractGroupIds(resource.getForm().getReceiversAsGroups());
      }
    } else {
      this.usersToBeNotified = emptyList();
      this.groupsToBeNotified = emptyList();
    }
  }

  @Override
  protected void perform(final FormInstance resource) {
    super.perform(resource);
    getNotificationMetaData().displayReceiversInFooter();
  }

  @Override
  protected String getBundleSubjectKey() {
    return "formsOnline.msgFormToValid";
  }

  @Override
  protected String getTemplateFileName() {
    return "notificationToValidate";
  }

  @Override
  protected Collection<String> getUserIdsToNotify() {
    return usersToBeNotified;
  }

  @Override
  protected Collection<String> getGroupIdsToNotify() {
    return groupsToBeNotified;
  }

  /**
   * The meaning of the returned step number is "TO VALIDATE".
   * @return the next step number as integer.
   */
  @Override
  protected int getCurrentValidationStep() {
    return super.getCurrentValidationStep() + 1;
  }
}