/*
 *                 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.api.scenario;

/**
 * 

 * A ScenarioFactory creates scenarios of particular type, describes it and 
 * decides if that scenario type should be available for a particular DataObject type.
 * A Scenario implementation is always constructed using a ScenarioFactory.
 * The toString() method of a  ScenarioFactory implementation should return the 
 * name of the scenario type created by this factory. 
 * 
 * 

 * A ScenarioFactory should be registered in XML layers at the folder,
 * Plugins->XML->ScenarioFactories, like seen below.
 * 
 * 
 * <folder name="Plugins">
 *     <folder name="XML">
 *         <folder name="ScenarioFactories">
 *             <file name="org-netbeans-modules-xsl-scenario-FileXSLScenarioFactory.instance"/>
 *         </folder>
 *    </folder>
 * </folder>
 * 
 *
 * @author  asgeir@dimonsoftware.com
 * @deprecated Experimantal SPI
 */
public interface ScenarioFactory {
    
    /**
     * Creates a new scenario using this Factory.
     * @return a newly constructed Scenario.
     */
    Scenario createScenario();
    
    /**
     * Get the name of the scenario type created by this Factory.
     * @return The name of the scenario type created by this Factory.
     */
    String getName();  //getDisplayName()
    
    /**
     * Get a more detailed describtion of the scenario type created by this factory.
     * @return The describtion of the scenario type created by this factory.
     */
    String getDescription();
    
    /**
     * Decides if the scenario type created by this factory is allowed
     * for this DataObject
     * @param dataObject The DataObject which should be tested for this Factory.
     * @return true if this factory should be allowed for that DataObject.
     */
    boolean isEnabled(org.openide.loaders.DataObject dataObject);

    /** @link dependency 
     * @label creates*/
    /*#Scenario lnkScenario;*/
}