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.jcr.nodetype;
025    
026    import javax.jcr.nodetype.NodeDefinition;
027    import javax.jcr.nodetype.PropertyDefinition;
028    import net.jcip.annotations.NotThreadSafe;
029    
030    /**
031     * An interface for an existing node type definition, patterned after the approach in the proposed <a
032     * href="http://jcp.org/en/jsr/detail?id=283">JSR-283</a>.
033     */
034    @NotThreadSafe
035    public interface NodeTypeDefinition {
036    
037        /**
038         * Get the name of the node type being defined
039         * 
040         * @return the name
041         */
042        public String getName();
043    
044        /**
045         * Get the direct supertypes for this node type.
046         * 
047         * @return the names of the direct supertypes, or an empty array if there are none
048         */
049        public String[] getDeclaredSupertypes();
050    
051        /**
052         * Get whether this node type is abstract.
053         * 
054         * @return true if this node type is abstract, or false if it is concrete
055         */
056        public boolean isAbstract();
057    
058        /**
059         * Get whether this node type is a mixin.
060         * 
061         * @return true if this node type is a mixin, or false if it is concrete
062         */
063        public boolean isMixin();
064    
065        /**
066         * Get whether this node type supports orderable child nodes.
067         * 
068         * @return true if this node type supports orderable child nodes, or false otherwise
069         */
070        public boolean hasOrderableChildNodes();
071    
072        /**
073         * Get the name of the primary item for this node type
074         * 
075         * @return the name of the child node or property that represents the primary item for nodes that use this type, or null if
076         *         there is none
077         */
078        public String getPrimaryItemName();
079    
080        /**
081         * Get the array of property definition templates for this node type.
082         * 
083         * @return the node type's list of property definitions; never null
084         */
085        public PropertyDefinition[] getDeclaredPropertyDefinitions();
086    
087        /**
088         * Get the array of child node definition templates for this node type
089         * 
090         * @return the node type's list of child node definitions; never null
091         */
092    
093        public NodeDefinition[] getDeclaredNodeDefinitions();
094    }