/*
 * $Header: /home/cvspublic/jakarta-slide/proposals/wvcm/src/org/apache/wvcm/store/FolderAccessor.java,v 1.15 2004/07/30 06:52:26 ozeigermann Exp $
 * $Revision: 1.15 $
 * $Date: 2004/07/30 06:52:26 $
 *
 * ====================================================================
 *
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999-2003 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Slide", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 * [Additional notices, if required by prior licensing conditions]
 *
 */

package org.apache.wvcm.store;

import java.util.Iterator;
import java.util.List;
import javax.wvcm.PropertyNameList;
import javax.wvcm.Resource;
import javax.wvcm.WvcmException;

/**
 * Persistent folder state accessor.
 *
 * @author <a href="mailto:peter.nevermann@softwareag.com">Peter Nevermann</a>
 * @version $Revision: 1.15 $
 */
public interface FolderAccessor extends ResourceAccessor {

    /**
     * Return a list of proxies containing the requested set of properties, where the list
     * contains the folder itself and other members of that folder.
     *
     * @param    wantedPropertyList  the requested set of properties
     * @param    deep                if true, the result contains a proxy for every member
     *                               of the folder associated to this accessor; otherwise,
     *                               the result contains only proxies for the bound members
     *                               of the folder.
     * @return   an Iterator
     * @throws   WvcmException
     */
    public Iterator doReadMemberList(PropertyNameList wantedPropertyList, boolean deep) throws WvcmException;
    
    /**
     * Add a binding.
     *
     * @param    bindingName         a  String
     * @param    boundResource       a  Resource
     * @param    overwrite           a  boolean
     *
     * @throws   WvcmException
     *
     */
    public void doBind(String bindingName, Resource boundResource, boolean overwrite) throws WvcmException;
    
    /**
     * Remove a binding and add a binding.
     *
     * @param    bindingName         a  String
     * @param    boundResource       a  Resource
     * @param    overwrite           a  boolean
     *
     * @throws   WvcmException
     *
     */
    public void doRebind(String bindingName, Resource boundResource, boolean overwrite) throws WvcmException;

    /**
     * Remove a binding.
     *
     * @param    bindingName         a  String
     *
     * @throws   WvcmException
     */
    public void doUnbind( String bindingName ) throws WvcmException;
    
    /**
     * Return a list of {@link ControllableResource} objects
     * that identify the controllable resources that are members of
     * this {@link ControllableFolder} and whose versionHistory property identifies
     * a member of the <code>versionHistoryList</code> parameter.
     * @param versionHistoryList A list of {@link VersionHistory} objects that
     * are being located.
     * @param wantedPropertyList The properties to be retrieved for the
     * returned version-controlled resources.
     */
    public List doLocateByHistoryReport(List versionHistoryList, PropertyNameList wantedPropertyList) throws WvcmException;
}
