xref: /aoo41x/main/offapi/com/sun/star/ucb/XContentAccess.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_XContentAccess_idl__
#define __com_sun_star_ucb_XContentAccess_idl__

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

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

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

 published interface XContent;
 published interface XContentIdentifier;

//=============================================================================
/** specifies methods for obtaining information on a content in different
	levels.

	<p>For example, if there is a cursor which points to <type>XContent</type>s,
	this interface could be used to give the user access to the content under
	the cursor. If the client only needs the identifier string of the content,
	there is no need to first create the content object, then to obtain the
	string from it and after that to release the content.

    @version	1.0
    @author   	Kai Sommerfeld
    @see      	XContent
	@see	  	XContentIdentifier
*/

published interface XContentAccess : com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/** returns the identifier string of the content ( "cheap method" ).

		<p>Note that this string can be used later to recreate the content.

		@returns
		the identifier string.
	*/
	string queryContentIdentifierString();

	//-------------------------------------------------------------------------
	/** returns the identifier object of the content.

		@returns
		the identifier object.
	*/
	XContentIdentifier queryContentIdentifier();

	//-------------------------------------------------------------------------
	/** returns the content ( "most expensive method" ).

		@returns
		the content.
	*/
	XContent queryContent();
};

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

}; }; }; };

#endif