/*************************************************************************
 *
 *  $RCSfile: XParcel.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: Laszlo Kovacs: mi $ $Date: 2002/08/16 10:10:36 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 * 
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRUNTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc..
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef __com_sun_star_scripting_storage_XParcel_idl__
#define __com_sun_star_scripting_storage_XParcel_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif

#ifndef __com_sun_star_scripting_storage_XNameNode_idl__
#include <drafts/com/sun/star/scripting/storage/XNameNode.idl>
#endif

//=======================================================================

module drafts { module com { module sun { module star { module scripting { module storage {

//=======================================================================
/**
    XParcel 
	encapsulates a a parcel (used with the parcel manager interface
	XParcelStore
*/
interface XParcel : ::com::sun::star::uno::XInterface
{
        //--------------------------------------------------------------
	/**
	    add content to parcel; takes w3c standard urls with wildcard
	    support

	    @params url
		the w3c standard url, can contain wildcards: 
		file:/parcel1/wildcard/wildcard.java will add all the .java files
		from all directories below parcel1

	    @throws com::sun::star::io::IOException
                if the underlying storage can not be accessed
	*/
        void addContent( [in] string url)
                raises( ::com::sun::star::io::IOException );


	//--------------------------------------------------------------
        /**
            remove content from parcel; takes w3c standard urls with 
	    wildcard support

            @params url
                the w3c standard url, can contain wildcards:
                file:/parcel1/wildcard/wildcard.java will remove all the .java files
                from all directories below parcel1

            @throws com::sun::star::io::IOException
                if the underlying storage can not be accessed
        */
        void removeContent( [in] string url)
                raises( ::com::sun::star::io::IOException );


	//--------------------------------------------------------------
        /**
	    retrieve parcel name

	    @returns parcel name

            @throws com::sun::star::io::IOException
                if the underlying storage can not be accessed
        */
        string getName() 
                raises( ::com::sun::star::io::IOException );


	//--------------------------------------------------------------
        /**
            retrieve parcel file hierarchy (by name)

            @returns parcel file hierarchy (as XNameNode interface)

            @throws com::sun::star::io::IOException
                if the underlying storage can not be accessed
        */
        XNameNode getHierarchy()
                raises( ::com::sun::star::io::IOException );
};
}; }; }; }; }; };

#endif