001    /*
002     * JBoss DNA (http://www.jboss.org/dna)
003     * See the COPYRIGHT.txt file distributed with this work for information
004     * regarding copyright ownership.  Some portions may be licensed
005     * to Red Hat, Inc. under one or more contributor license agreements.
006     * See the AUTHORS.txt file in the distribution for a full listing of 
007     * individual contributors. 
008     *
009     * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA
010     * is licensed to you under the terms of the GNU Lesser General Public License as
011     * published by the Free Software Foundation; either version 2.1 of
012     * the License, or (at your option) any later version.
013     *
014     * JBoss DNA is distributed in the hope that it will be useful,
015     * but WITHOUT ANY WARRANTY; without even the implied warranty of
016     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017     * Lesser General Public License for more details.
018     *
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this software; if not, write to the Free
021     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
023     */
024    package org.jboss.dna.common.jdbc.model.api;
025    
026    import java.util.Map;
027    
028    /**
029     * Provides database named object specific metadata.
030     * 
031     * @author <a href="mailto:litsenko_sergey@yahoo.com">Sergiy Litsenko</a>
032     */
033    public interface DatabaseNamedObject extends CoreMetaData {
034    
035        /**
036         * Gets database named object name
037         * 
038         * @return database named object name
039         */
040        String getName();
041    
042        /**
043         * Sets database named object name
044         * 
045         * @param name the database named object name
046         */
047        void setName( String name );
048    
049        /**
050         * Gets explanatory comment on the database named object
051         * 
052         * @return explanatory comment on the database named object
053         */
054        String getRemarks();
055    
056        /**
057         * Sets explanatory comment on the database named object
058         * 
059         * @param remarks the explanatory comment on the database named object
060         */
061        void setRemarks( String remarks );
062    
063        /**
064         * Gets extra (non standard) properties if provided by database.
065         * 
066         * @return extra properties if provided by database
067         */
068        Map<String, Object> getExtraProperties();
069    
070        /**
071         * Gets extra (non standard) property if provided by database.
072         * 
073         * @param key the key
074         * @return extra property if provided by database
075         */
076        Object getExtraProperty( String key );
077    
078        /**
079         * Adds extra property
080         * 
081         * @param key the key
082         * @param value the value
083         */
084        void addExtraProperty( String key,
085                               Object value );
086    
087        /**
088         * deletes extra property
089         * 
090         * @param key the key
091         */
092        void deleteExtraProperty( String key );
093    }