/*
 * Copyright (C) 2009 eXo Platform SAS.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.exoplatform.services.jcr.core.nodetype;

import org.exoplatform.services.jcr.datamodel.InternalQName;

import java.io.InputStream;
import java.util.List;

import javax.jcr.RepositoryException;
import javax.jcr.UnsupportedRepositoryOperationException;
import javax.jcr.nodetype.NoSuchNodeTypeException;
import javax.jcr.nodetype.NodeType;
import javax.jcr.nodetype.NodeTypeIterator;
import javax.jcr.nodetype.NodeTypeManager;

/**
 * Created by The eXo Platform SAS<br>
 *
 * Node Type manager interface.
 * 
 * @author <a href="mailto:gennady.azarenkov@exoplatform.com">Gennady Azarenkov</a>
 * @LevelAPI Unsupported
 */
public interface ExtendedNodeTypeManager extends NodeTypeManager
{

   public static final int IGNORE_IF_EXISTS = 0;

   public static final int FAIL_IF_EXISTS = 2;

   public static final int REPLACE_IF_EXISTS = 4;

    /**
     * Return NodeType for a given InternalQName.
     *
     * @param qname nodetype name
     * @return NodeType
     * @throws NoSuchNodeTypeException if no nodetype found with the name
     * @throws RepositoryException Repository error
     */
   NodeType findNodeType(InternalQName qname) throws NoSuchNodeTypeException, RepositoryException;

   /**
    * Registers node type using value object.
    * 
    * @param nodeTypeValue
    * @param alreadyExistsBehaviour
    * @throws RepositoryException
    */
   NodeType registerNodeType(NodeTypeValue nodeTypeValue, int alreadyExistsBehaviour) throws RepositoryException;

   /**
    * Registers all node types using XML binding value objects from xml stream.
    * 
    * @param xml a InputStream
    * @param alreadyExistsBehaviour a int
    * @throws RepositoryException
    */
   NodeTypeIterator registerNodeTypes(InputStream xml, int alreadyExistsBehaviour, String contentType)
      throws RepositoryException;

   /**
    * Gives the {@link NodeTypeManager}
    *
    * @throws RepositoryException if another error occurs.
    */
   NodeTypeDataManager getNodeTypesHolder() throws RepositoryException;

   // ------ JCR 2 related features methods ------

   /**
    * Return <code>NodeTypeValue</code> for a given nodetype name. Used for
    * nodetype update. Value can be edited and registered via
    * <code>registerNodeType(NodeTypeValue nodeTypeValue, int alreadyExistsBehaviour)</code>
    * .
    * 
    * @param ntName nodetype name
    * @return NodeTypeValue
    * @throws NoSuchNodeTypeException if no nodetype found with the name
    * @throws RepositoryException Repository error
    */
   NodeTypeValue getNodeTypeValue(String ntName) throws NoSuchNodeTypeException, RepositoryException;

   /**
    * Registers or updates the specified <code>Collection</code> of
    * <code>NodeTypeValue</code> objects. This method is used to register or
    * update a set of node types with mutual dependencies. Returns an iterator
    * over the resulting <code>NodeType</code> objects. <p/> The effect of the
    * method is "all or nothing"; if an error occurs, no node types are
    * registered or updated. <p/> Throws an
    * <code>InvalidNodeTypeDefinitionException</code> if a
    * <code>NodeTypeDefinition</code> within the <code>Collection</code> is
    * invalid or if the <code>Collection</code> contains an object of a type
    * other than <code>NodeTypeDefinition</code> . <p/> Throws a
    * <code>NodeTypeExistsException</code> if <code>allowUpdate</code> is
    * <code>false</code> and a <code>NodeTypeDefinition</code> within the
    * <code>Collection</code> specifies a node type name that is already
    * registered. <p/> Throws an
    * <code>UnsupportedRepositoryOperationException</code> if this implementation
    * does not support node type registration.
    * 
    * @param values a collection of <code>NodeTypeValue</code>s
    * @param alreadyExistsBehaviour a int
    * @return the registered node types.
    * @throws UnsupportedRepositoryOperationException if this implementation does
    *           not support node type registration.
    * @throws RepositoryException if another error occurs.
    */
   public NodeTypeIterator registerNodeTypes(List<NodeTypeValue> values, int alreadyExistsBehaviour)
      throws UnsupportedRepositoryOperationException, RepositoryException;

   /**
    * Unregisters the specified node type.
    * 
    * @param name a <code>String</code>.
    * @throws UnsupportedRepositoryOperationException if this implementation does
    *           not support node type registration.
    * @throws NoSuchNodeTypeException if no registered node type exists with the
    *           specified name.
    * @throws RepositoryException if another error occurs.
    */
   public void unregisterNodeType(String name) throws UnsupportedRepositoryOperationException, NoSuchNodeTypeException,
      RepositoryException;

   /**
    * Unregisters the specified set of node types.<p/> Used to unregister a set
    * of node types with mutual dependencies.
    * 
    * @param names a <code>String</code> array
    * @throws UnsupportedRepositoryOperationException if this implementation does
    *           not support node type registration.
    * @throws NoSuchNodeTypeException if one of the names listed is not a
    *           registered node type.
    * @throws RepositoryException if another error occurs.
    */
   public void unregisterNodeTypes(String[] names) throws UnsupportedRepositoryOperationException,
      NoSuchNodeTypeException, RepositoryException;
}
