org.apache.jackrabbit.spi.QNodeTypeDefinition Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jackrabbit.spi;
import java.util.Collection;
/**
* QNodeTypeDefinition is the SPI representation of a
* {@link javax.jcr.nodetype.NodeType node type}. It refers to Names
* only and is therefore independent of session-specific namespace mappings.
*
* @see javax.jcr.nodetype.NodeType
*/
public interface QNodeTypeDefinition {
/**
* Returns the name of the node type being defined or
* null if not set.
*
* @return the name of the node type or null if not set.
*/
public Name getName();
/**
* Returns an array containing the names of the supertypes. If no
* supertypes have been specified, then an empty array is returned
* for mixin types and the nt:base primary type and
* an array containing just nt:base for other primary types.
*
* The returned array must not be modified by the application.
*
* @return an array of supertype names
*/
public Name[] getSupertypes();
/**
* Returns an array containing the names of additional mixin types
* supported on this node type.
*
* The returned array must not be modified by the application.
*
* @return an array of mixin type names, or null
* when there are no known constraints.
*/
public Name[] getSupportedMixinTypes();
/**
* Returns the value of the mixin flag.
*
* @return true if this is a mixin node type; false otherwise.
*/
public boolean isMixin();
/**
* Returns true if the definition is abstract; false otherwise.
*
* @return true if the definition is abstract; false otherwise.
* @since JCR 2.0
*/
public boolean isAbstract();
/**
* Returns true if the definition is queryable; false otherwise.
*
* @return true if the definition is queryable; false otherwise.
* @since JCR 2.0
*/
public boolean isQueryable();
/**
* Returns the value of the orderableChildNodes flag.
*
* @return true if nodes of this node type can have orderable child nodes; false otherwise.
*/
public boolean hasOrderableChildNodes();
/**
* Returns the name of the primary item (one of the child items of the
* node's of this node type) or null if not set.
*
* @return the name of the primary item or null if not set.
*/
public Name getPrimaryItemName();
/**
* Returns an array containing the property definitions.
*
* @return an array containing the property definitions.
*/
public QPropertyDefinition[] getPropertyDefs();
/**
* Returns an array containing the child node definitions.
*
* @return an array containing the child node definitions.
*/
public QNodeDefinition[] getChildNodeDefs();
/**
* Returns a collection of node type Names that are being
* referenced by this node type definition (e.g. as supertypes, as
* required/default primary types in child node definitions, as REFERENCE
* value constraints in property definitions).
*
* Note that self-references (e.g. a child node definition that specifies
* the declaring node type as the default primary type) are not considered
* dependencies.
*
* @return a collection of node type Names
*/
public Collection getDependencies();
}