/*
 *                 Sun Public License Notice
 * 
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 * 
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2002 Sun
 * Microsystems, Inc. All Rights Reserved.
 */
package org.netbeans.modules.xml.core.cookies;

import java.io.Serializable;
import java.util.Vector;
import org.netbeans.modules.xml.api.scenario.Scenario;

/**
 * Keeps scenario information which should be stored persistently per
 * DataObject.
 *
 * @author  asgeir@dimonsoftware.com
 */
public class ScenarioData implements Serializable {
    
    /** Serial Version UID */
    private static final long serialVersionUID = -6268945794243989727L;
    
    /** A collection of Scenario objects */
    private Vector scenarios; //XXX Vector is not good because it contains client implementations of Scenario and when such implementation is not available, the deserialization of entire Vector could be interupted. Rewrite it to custom [de]serialization object byte object!
    
    /** Index of the active scenario in the scenarios vector*/
    private int activeScenarioIndex;

    /** @link dependency */
    /*# Scenario lnkScenario; */

    /** Creates a new instance of ScenarioData */
    public ScenarioData() {
        scenarios = new Vector();
        activeScenarioIndex = -1;
    }
    
    /**
     * @return A collection of Scenario objects
     */
    public Vector getScenarios() {
        return scenarios;
    }

    /**
     * Sets the index of the active scenario in the scenarios vector.
     * The value should be >= 0 and < the size of the vector returned by
     * getScenarios().
     */
    public void setActiveScenarioIndex(int index) {
        activeScenarioIndex = index;
    }

    /**
     * @return Index of the active scenario in the scenarios vector
     */
    public int getActiveScenarioIndex() {
        return activeScenarioIndex;
    }        
}