/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: ContentInfo.idl,v $
 *
 *  $Revision: 1.10 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 07:17:20 $
 *
 *  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_ucb_ContentInfo_idl__
#define __com_sun_star_ucb_ContentInfo_idl__

#ifndef __com_sun_star_beans_Property_idl__
#include <com/sun/star/beans/Property.idl>
#endif

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

module com { module sun { module star { module ucb {

//=============================================================================
/** A structure for information about contents.

	@see XContentCreator
	@see XCommandProcessor
*/
published struct ContentInfo
{
	//-------------------------------------------------------------------------
	/** A type identifier string for a content.

	    <p>This is an implementation specific string characterizing the
		kind of a content (e.g. "application/vnd.sun.star.hierarchy-link").
		The value of this member should match the value returned by
		<member>XContent::getContentType</member> of an appropriate content.
	*/
	string Type;

	//-------------------------------------------------------------------------
	/** Additional attributes.

	    <p>These flags contain extra information on the content, like its kind
		(KIND_FOLDER, KIND_DOCUMENT, KIND_LINK).

		<p>It is highly recommended to fill these flags very accurately, as
		they are very important when transferring contents between different
		<type>ContentProvider</type>s.

		<p>The value can be one of the <type>ContentInfoAttribute</type>
		   constants.
	*/
	long Attributes;

	//-------------------------------------------------------------------------
	/** This field contains a list with the properties which must be set at
	    a content that was just created using
		<member>XContentCreator::createNewContent</member> before it can be
		committed (by executing the command "insert" at the new content).

		<p>If one of the properties is missing, the insert command will fail.

		<p>In example, a new file system folder content will need a title. The
		Properties member of the ContentInfo provided for this kind of
		content must include the property "Title".

		<p><b>Important:</b> The required properties must have one of the
		following basic data types (in order to make it possible to implement
		client applications with a small set of generic input methods for the
		values):

		<p>
		<ul>
		<li>boolean
		<li>char
		<li>byte
		<li>string
		<li>short
		<li>long
		<li>hyper
		<li>float
		<li>double
		</ul>
	*/
	sequence< com::sun::star::beans::Property > Properties;
};

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

}; }; }; };

#endif
