001    /* 
002     * This file is part of the Echo Point Project.  This project is a collection
003     * of Components that have extended the Echo Web Application Framework.
004     *
005     * Version: MPL 1.1/GPL 2.0/LGPL 2.1
006     *
007     * The contents of this file are subject to the Mozilla Public License Version
008     * 1.1 (the "License"); you may not use this file except in compliance with
009     * the License. You may obtain a copy of the License at
010     * http://www.mozilla.org/MPL/
011     *
012     * Software distributed under the License is distributed on an "AS IS" basis,
013     * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
014     * for the specific language governing rights and limitations under the
015     * License.
016     *
017     * Alternatively, the contents of this file may be used under the terms of
018     * either the GNU General Public License Version 2 or later (the "GPL"), or
019     * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
020     * in which case the provisions of the GPL or the LGPL are applicable instead
021     * of those above. If you wish to allow use of your version of this file only
022     * under the terms of either the GPL or the LGPL, and not to allow others to
023     * use your version of this file under the terms of the MPL, indicate your
024     * decision by deleting the provisions above and replace them with the notice
025     * and other provisions required by the GPL or the LGPL. If you do not delete
026     * the provisions above, a recipient may use your version of this file under
027     * the terms of any one of the MPL, the GPL or the LGPL.
028     */
029    package echopoint.able;
030    
031    /** 
032     * <code>Attributeable</code> is an interface that allows a Component to have
033     * a series of objects associated with attribute names.  This attribute setting
034     * follows standard HashMap semantics.
035     * <p>
036     * The rendering peer code for the Component will also use these attributes
037     * to render out this attribute information on the client.
038     */
039    
040    public interface Attributeable {
041            
042            /**
043             * Returns a String array with the names of the the attributes that have neen set.
044             * 
045             * @return a String array with the names of the the attributes that have neen set.
046             */
047            public String[] getAttributeNames();
048    
049            /**
050             * Returns a value for the given attribute name or null if one cannot be found.
051             * 
052             * @param attributeName - the name of the attribute to return
053             * 
054             * @return a value for the given attribute name or null if one cannot be found.
055             */
056            public Object getAttribute(String attributeName);
057    
058            /**
059             * Sets a value for a given attribute name.
060             * 
061             * @param attributeName - the name of the attribute to set
062             * @param attributeValue - the value for the attribute
063             * 
064             */
065            public void setAttribute(String attributeName, Object attributeValue);
066    }
067