alfresco-community-repo/source/java/org/alfresco/web/bean/wizard/WizardState.java

/*
 * #%L
 * Alfresco Repository WAR Community
 * %%
 * Copyright (C) 2005 - 2016 Alfresco Software Limited
 * %%
 * This file is part of the Alfresco software. 
 * If the software was purchased under a paid Alfresco license, the terms of 
 * the paid license agreement will prevail.  Otherwise, the software is 
 * provided under the following open source license terms:
 * 
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * Alfresco 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */
package org.alfresco.web.bean.wizard;

import java.io.Serializable;
import java.util.List;

import org.alfresco.web.app.AlfrescoNavigationHandler;
import org.alfresco.web.config.WizardsConfigElement.PageConfig;
import org.alfresco.web.config.WizardsConfigElement.StepConfig;
import org.alfresco.web.config.WizardsConfigElement.WizardConfig;

/**
 * Object responsible for holding the current state of an active wizard.
 * 
 * @author gavinc
 */
public final class WizardState implements Serializable
{
   private static final long serialVersionUID = -6816474382767569256L;
   
   private int currentStep = 1;
   private PageConfig currentPageCfg;
   private WizardConfig config;
   private IWizardBean wizard;
   private List<StepConfig> steps;
   
   /**
    * Default constructor
    * 
    * @param config The configuration for the wizard
    * @param wizard The wizard bean instance
    */
   public WizardState(WizardConfig config, IWizardBean wizard)
   {
      this.config = config;
      this.wizard = wizard;
      
      this.steps = this.config.getStepsAsList();
   }

   /**
    * Sets the configuration for the current page of the wizard
    * 
    * @param currentPageCfg The configuration
    */
   public void setCurrentPageCfg(PageConfig currentPageCfg)
   {
      this.currentPageCfg = currentPageCfg;
   }
   
   /**
    * Sets the current step the wizard is on
    * 
    * @param currentStep The current step number
    */
   public void setCurrentStep(int currentStep)
   {
      this.currentStep = currentStep;
   }
   
   /**
    * Returns the wizard bean instance
    * 
    * @return The wizard bean instance
    */
   public IWizardBean getWizard()
   {
      return this.wizard;
   }

   /**
    * Returns the configuration for the current wizard
    * 
    * @return The wizard configuration
    */
   public WizardConfig getConfig()
   {
      return this.config;
   }
   
   /**
    * Returns the configuration for the current page of the wizard
    * 
    * @return The current page configuration
    */
   public PageConfig getCurrentPageCfg()
   {
      return currentPageCfg;
   }

   /**
    * The current step the wizard is on
    * 
    * @return The current wizard step
    */
   public int getCurrentStep()
   {
      return currentStep;
   }

   /**
    * Returns the list of steps the wizard has
    * 
    * @return List of wizard steps
    */
   public List<StepConfig> getSteps()
   {
      return steps;
   }
   
   @Override
   public String toString()
   {
      return AlfrescoNavigationHandler.WIZARD_PREFIX + this.config.getName() + 
            "[" + this.currentStep + "]";
   }
}