/*
 * QQQ - Low-code Application Framework for Engineers.
 * Copyright (C) 2021-2022.  Kingsrook, LLC
 * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
 * contact@kingsrook.com
 * https://github.com/Kingsrook/
 *
 * 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.
 *
 * 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 com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend;


import java.util.ArrayList;
import com.kingsrook.qqq.backend.core.model.actions.processes.ProcessSummaryLineInterface;
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepOutput;


/*******************************************************************************
 ** Interface for a class that can provide a ProcessSummary - a list of Process Summary Lines
 *******************************************************************************/
public interface ProcessSummaryProviderInterface
{

   /*******************************************************************************
    ** Note - object needs to be serializable, and List isn't... so, use ArrayList?
    *******************************************************************************/
   ArrayList<ProcessSummaryLineInterface> getProcessSummary(RunBackendStepOutput runBackendStepOutput, boolean isForResultScreen);


   /*******************************************************************************
    ** not meant to be overridden - meant to be called by framework - to make sure that
    ** all lines have their proper message picked (e.g., if they have singular/plural
    ** and past/future variants).
    *******************************************************************************/
   default ArrayList<ProcessSummaryLineInterface> doGetProcessSummary(RunBackendStepOutput runBackendStepOutput, boolean isForResultScreen)
   {
      ArrayList<ProcessSummaryLineInterface> processSummary = getProcessSummary(runBackendStepOutput, isForResultScreen);
      if(processSummary == null)
      {
         return (null);
      }

      for(ProcessSummaryLineInterface processSummaryLine : processSummary)
      {
         processSummaryLine.prepareForFrontend(isForResultScreen);
      }

      return (processSummary);
   }

}
