/**************************************************************************************************
 **
 ** $Id: Inheritance.java 831 2006-05-01 00:27:23Z Desruisseaux $
 **
 ** $URL: http://svn.code.sf.net/p/geoapi/code/branches/2.0.x/geoapi/src/main/java/org/opengis/go/display/style/Inheritance.java $
 **
 ** Copyright (C) 2003 Open GIS Consortium, Inc. All Rights Reserved. http://www.opengis.org/Legal/
 **
 *************************************************************************************************/
package org.opengis.go.display.style;


/**
 * Encapsulates the inheritance attributes that can be applied to any
 * {@link org.opengis.go.display.primitive.Graphic}.
 *
 * @version 0.2
 * @author OpenGIS® consortium
 */
public interface Inheritance {
    /**
     * Default inherit style from parent value.
     */
    public static final boolean DEFAULT_INHERIT_STYLE_FROM_PARENT = false;

    /**
     * Default override aggregated graphics value.
     */
    public static final boolean DEFAULT_OVERRIDE_AGGREGATED_GRAPHICS = false;
    
    /**
     * Inherit style from parent attribute name.
     */
    public static final String INHERIT_STYLE_FROM_PARENT = "INHERITANCE_INHERIT_STYLE_FROM_PARENT";

    /**
     * Override aggregated graphics attribute name.
     */
    public static final String OVERRIDE_AGGREGATED_GRAPHICS = "INHERITANCE_OVERRIDE_AGGREGATED_GRAPHICS";
            
    /**
     * Returns the inherit style from parent value.
     *
     * @return the inherit style from parent value.
     */
    public boolean isInheritingStyleFromParent();
    
    /**
     * Returns whether the inherit style from parent value has been set.
     *
     * @return true if the inherit style from parent value
     *         has been set, false otherwise.
     */    
    public boolean isInheritingStyleFromParentSet();
    
    /**
     * Sets the inherit style from parent value.
     *
     * @param inheritStyleFromParent the inherit style from parent value.
     */    
    public void setInheritingStyleFromParent(boolean inheritStyleFromParent);
    
    /**
     * Sets the fact that the inherit style from parent value has been set.
     *
     * @param flag true if the inherit style from parent value
     *             has been set, false otherwise.
     */    
    public void setInheritingStyleFromParentSet(boolean flag);
 
    /**
     * Returns the override aggregated graphics value.
     *
     * @return the override aggregated graphics value.
     */
    public boolean isOverridingAggregatedGraphics();
    
    /**
     * Returns whether the override aggregated graphics value has been set.
     *
     * @return true if the override aggregated graphics value
     *         has been set, false otherwise.
     */    
    public boolean isOverridingAggregatedGraphicsSet();
    
    /**
     * Sets the override aggregated graphics value.
     *
     * @param overrideAggregatedGraphics the override aggregated graphics value.
     */    
    public void setOverridingAggregatedGraphics(boolean overrideAggregatedGraphics);
    
    /**
     * Sets the fact that the override aggregated graphics value has been set.
     *
     * @param flag true if the override aggregated graphics value
     *             has been set, false otherwise.
     */    
    public void setOverridingAggregatedGraphicsSet(boolean flag);
}