/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 * 
 *    (C) 2003-2008, Open Source Geospatial Foundation (OSGeo)
 *
 *    This library 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;
 *    version 2.1 of the License.
 *
 *    This library 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.
 */
package org.geotools.styling;


/**
 * A NamedStyle is used to refer to a style that has a name in a WMS.
 *
 * <p>
 * A NamedStyle is a Style that has only Name, so all setters other than
 * setName will throw an <code>UnsupportedOperationException</code>
 * </p>
 * The details of this object are taken from the <a
 * href="https://portal.opengeospatial.org/files/?artifact_id=1188"> OGC
 * Styled-Layer Descriptor Report (OGC 02-070) version 1.0.0.</a>:
 * <pre><code>
 * <xsd:element name="NamedStyle">
 *   <xsd:annotation>
 *     <xsd:documentation>
 *       A NamedStyle is used to refer to a style that has a name in a WMS.
 *     </xsd:documentation>
 *   </xsd:annotation>
 *   <xsd:complexType>
 *     <xsd:sequence>
 *       <xsd:element ref="sld:Name"/>
 *     </xsd:sequence>
 *   </xsd:complexType>
 * </xsd:element>
 * </code></pre>
 *
 * @author James Macgill
 *
 * @source $URL$
 */
public interface NamedStyle extends Style {
    
    // public String getName();

    // public void setName(String name);

    /**
     * Human readible title.
     * 
     * @return getDescription().getTitle().toString()
     *
     * @deprecated Use getDescription().getTitle().toString()
     */
    //public String getTitle();

    /**
     * @param title Human readible title
     *
     * @deprecated Use getDescription().setTitle()
     */
    //public void setTitle(String title);

    /**
     * @return getDescription().getAbstract()
     *
     * @deprecated Use getDescription().getAbstract()
     */
    //public String getAbstract();

    /**
     * @param abstractStr Description of this style
     *
     * @deprecated Use getDescription().setAbstract()
     */
    //public void setAbstract(String abstractStr);

    /**
     * @return true if this is the default style to use
     */
    //public boolean isDefault();

    //public void setDefault(boolean isDefault);

    //public FeatureTypeStyle[] getFeatureTypeStyles();

    //public void setFeatureTypeStyles(FeatureTypeStyle[] types);

    //public void addFeatureTypeStyle(FeatureTypeStyle type);

    //public void accept(org.geotools.styling.StyleVisitor visitor);
}