xref: /trunk/main/offapi/com/sun/star/ucb/XDataContainer.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_ucb_XDataContainer_idl__
#define __com_sun_star_ucb_XDataContainer_idl__

#ifndef __com_sun_star_container_XIndexContainer_idl__
#include <com/sun/star/container/XIndexContainer.idl>
#endif


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

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

//=============================================================================
/** specifies a container for (binary) data.

	<p>A data container may contain data and/or other data containers.
	A typical container with children is a MIME message with
	attachments.

	@version	1.0
	@author 	Kai Sommerfeld

    @deprecated
*/
published interface XDataContainer: com::sun::star::container::XIndexContainer
{
	//-------------------------------------------------------------------------
	/** returns the content type (MIME Type) of the data container.

		@returns
		the content type
	*/
	string getContentType();

	//-------------------------------------------------------------------------
	/** sets the content type (MIME Type) of the data container.

		@param aType
		the content type
	*/
	void setContentType( [in] string aType );

	//-------------------------------------------------------------------------
	/** returns the data of the data container.

		@returns
		the data
	*/
	sequence<byte> getData();

	//-------------------------------------------------------------------------
	/** sets the data of the data container.

		@param aData
		the data
	*/
	void setData( [in] sequence<byte> aData );

	//-------------------------------------------------------------------------
	/** Deprecated. Do not use!

		@deprecated
	*/
	string getDataURL();

	//-------------------------------------------------------------------------
	/** Deprecated. Do not use!

		@deprecated
	*/
	void setDataURL( [in] string aURL );
};

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

}; }; }; };

#endif