FormsOnlineService.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.model;

import org.apache.commons.fileupload.FileItem;
import org.silverpeas.core.ApplicationService;
import org.silverpeas.core.admin.PaginationPage;
import org.silverpeas.core.contribution.content.form.FormException;
import org.silverpeas.core.contribution.model.ContributionIdentifier;
import org.silverpeas.core.contribution.template.publication.PublicationTemplateException;
import org.silverpeas.core.util.Pair;
import org.silverpeas.core.util.ServiceProvider;

import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;

public interface FormsOnlineService extends ApplicationService {

  static FormsOnlineService get() {
    return ServiceProvider.getService(FormsOnlineService.class);
  }

  @Override
  @SuppressWarnings("unchecked")
  Optional<FormInstance> getContributionById(final ContributionIdentifier contributionId);

  List<FormDetail> getAllForms(String appId, String userId, boolean withSendInfo)
      throws FormsOnlineException;

  FormDetail loadForm(FormPK pk) throws FormsOnlineException;

  FormDetail saveForm(FormDetail form,
      Map<String, Pair<List<String>, List<String>>> userAndGroupIdsByRightTypes) throws FormsOnlineException;

  boolean deleteForm(FormPK pk) throws FormsOnlineException;

  void publishForm(FormPK pk) throws FormsOnlineException;

  void unpublishForm(FormPK pk) throws FormsOnlineException;

  List<FormDetail> getAvailableFormsToSend(Collection<String> appIds, String userId, String orderBy)
      throws FormsOnlineException;

  RequestsByStatus getAllUserRequests(String appId, String userId,
      final PaginationPage paginationPage)
      throws FormsOnlineException;

  RequestsByStatus getValidatorRequests(RequestsFilter filter, String validatorId,
      final PaginationPage paginationPage) throws FormsOnlineException;

  /**
   * Gets the {@link FormInstanceValidationType} instances mapped by form identifiers of the
   * validator represented by given validator id and validator group ids on the given component
   * instance.
   * @param appId the identifier of the component instance.
   * @param validatorId the identifier of the validator.
   * @param formIds optional filter about form identifiers in order to reduce the search load.
   * @return {@link FormInstanceValidationType} instances mapped by form identifiers.
   * @throws FormsOnlineException if an error occurs
   */
  Map<String, Set<FormInstanceValidationType>> getValidatorFormIdsWithValidationTypes(String appId,
      String validatorId, final Collection<String> formIds) throws FormsOnlineException;

  FormInstance loadRequest(RequestPK pk, String userId)
      throws FormsOnlineException, PublicationTemplateException, FormException;

  FormInstance loadRequest(RequestPK pk, String userId, boolean editionMode)
      throws FormsOnlineException;

  void saveRequest(FormPK pk, String userId, List<FileItem> items, boolean draft)
      throws FormsOnlineException;

  /**
   * Register a step of validation of the request represented by the given identifier.
   * <p>
   * The service ensure that the validator is able to validate the given request. In case of the
   * validator can not validate, an error is thrown.
   * </p>
   * @param pk the unique identifier of the aimed request.
   * @param validatorId the identifier of the validator.
   * @param decision the validation decision ("validate" or "refused")
   * @param comment the validation comment.
   * @param follower a boolean flag. True means that the validator want to follow the next steps
   * of validation.
   * @throws FormsOnlineException if the validator can not validate indeed or on technical error.
   */
  void saveNextRequestValidationStep(RequestPK pk, String validatorId, String decision, String comment,
      boolean follower) throws FormsOnlineException;

  /**
   * Cancels the request represented by the given identifier.
   * <p>
   * The service ensures that the current user is the creator of the request. In case of the
   * validator can not validate, an error is thrown.
   * </p>
   * @param pk the unique identifier of the aimed request.
   * @throws FormsOnlineException if the current user can not cancel the request or on technical error.
   */
  void cancelRequest(RequestPK pk) throws FormsOnlineException;

  /**
   * Archives the request represented by the given identifier.
   * <p>
   * The service ensures that the current user is able to archive the request. In case of the
   * validator can not validate, an error is thrown.
   * </p>
   * @param pk the unique identifier of the aimed request.
   * @throws FormsOnlineException if the current user can not archive the request or on technical error.
   */
  void archiveRequest(RequestPK pk) throws FormsOnlineException;

  /**
   * Deletes the request represented by the given identifier.
   * <p>
   * The service ensures that the current user is able to delete the request. In case of the
   * validator can not validate, an error is thrown.
   * </p>
   * @param pk the unique identifier of the aimed request.
   * @throws FormsOnlineException if the current user can not delete the request or on technical error.
   */
  void deleteRequest(RequestPK pk) throws FormsOnlineException;

  void index(String componentId);
}