1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_XContentAccess_idl__
24#define __com_sun_star_ucb_XContentAccess_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30//=============================================================================
31
32module com { module sun { module star { module ucb {
33
34 published interface XContent;
35 published interface XContentIdentifier;
36
37//=============================================================================
38/** specifies methods for obtaining information on a content in different
39	levels.
40
41	<p>For example, if there is a cursor which points to <type>XContent</type>s,
42	this interface could be used to give the user access to the content under
43	the cursor. If the client only needs the identifier string of the content,
44	there is no need to first create the content object, then to obtain the
45	string from it and after that to release the content.
46
47    @version	1.0
48    @author   	Kai Sommerfeld
49    @see      	XContent
50	@see	  	XContentIdentifier
51*/
52
53published interface XContentAccess : com::sun::star::uno::XInterface
54{
55	//-------------------------------------------------------------------------
56	/** returns the identifier string of the content ( "cheap method" ).
57
58		<p>Note that this string can be used later to recreate the content.
59
60		@returns
61		the identifier string.
62	*/
63	string queryContentIdentifierString();
64
65	//-------------------------------------------------------------------------
66	/** returns the identifier object of the content.
67
68		@returns
69		the identifier object.
70	*/
71	XContentIdentifier queryContentIdentifier();
72
73	//-------------------------------------------------------------------------
74	/** returns the content ( "most expensive method" ).
75
76		@returns
77		the content.
78	*/
79	XContent queryContent();
80};
81
82//=============================================================================
83
84}; }; }; };
85
86#endif
87