/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: PackageFolder.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 02:28:18 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/
#ifndef __com_sun_star_packages_PackageFolder_idl__ 
#define __com_sun_star_packages_PackageFolder_idl__ 
 
#ifndef __com_sun_star_container_XNamed_idl__ 
#include <com/sun/star/container/XNamed.idl>
#endif

#ifndef __com_sun_star_container_XChild_idl__ 
#include <com/sun/star/container/XChild.idl>
#endif

#ifndef __com_sun_star_container_XNameContainer_idl__ 
#include <com/sun/star/container/XNameContainer.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__ 
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_container_XEnumerationAccess_udl__ 
#include <com/sun/star/container/XEnumerationAccess.idl>
#endif
//============================================================================= 
 
module com {  module sun {  module star {   module packages {  
 
//============================================================================= 
/**
	The PackageFolder service represents a single folder or directory within 
	a Package. Instances of this service can only be constructed by an
	implementation of the Package service and not via the service manager.
*/
published service PackageFolder
{
	/**
	This interface is used to get or set the name of the folder.
	*/
	interface com::sun::star::container::XNamed;
	/**
	The getParent method of XChild will return the PackageFolder that 
	contains this PackageFolder or nothing if this PackageFolder is
	the root PackageFolder.

	setParent will move the PackageFolder.
	*/
	interface com::sun::star::container::XChild;
	/**
	This interface describes all of the PackageFolders and PackageStreams
	which are contained within this instance of the PackageFolder service.

	XElementAccess::getElementType returns service PackageStream
	XNameAccess::getByName returns either a PackageFolder or a PackageStream
		as a css::uno::Any
	XNameAccess::getElementNames returns an uno::Sequence of strings containing
		the names of all children stored in the PackageFolder
	*/
	interface com::sun::star::container::XNameContainer;
	/**
	This interface will return an implementation of service 
	PackageFolderEnumeration, which represents an iterator over the children
	of the PackageFolder, or the PackageStreams and PackageFolders contained
	within this instance of the PackageFolder service.
	
	This provides a "snapshot" of the contents of the
	PackageFolder at the time of construction. It is the responsibility of the
	caller to ensure that any given member of the enumeration refers to a valid
	PackageStream or PackageFolder. 
	
	*/
	interface com::sun::star::container::XEnumerationAccess;

	/**
	This interface provides access to the properties of the package entry.
	Currently, this only supports one entry which is a string called
	MediaType. This contains the MIME type of the stream (eg. "text/html").
	For PackageFolders, this is always an empty string.
	*/
	interface com::sun::star::beans::XPropertySet;
};
}; }; }; };
 
#endif 
