xref: /AOO41X/main/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl (revision 34c958ab2597dc3f66146be0dc1758f0ba5d93f5)
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_TransientDocumentsStreamContent_idl__
24#define __com_sun_star_ucb_TransientDocumentsStreamContent_idl__
25
26#ifndef __com_sun_star_lang_XComponent_idl__
27#include <com/sun/star/lang/XComponent.idl>
28#endif
29
30#ifndef __com_sun_star_ucb_XContent_idl__
31#include <com/sun/star/ucb/XContent.idl>
32#endif
33
34#ifndef __com_sun_star_ucb_XCommandProcessor_idl__
35#include <com/sun/star/ucb/XCommandProcessor.idl>
36#endif
37
38#ifndef __com_sun_star_ucb_XCommandProcessor2_idl__
39#include <com/sun/star/ucb/XCommandProcessor2.idl>
40#endif
41
42#ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__
43#include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
44#endif
45
46#ifndef __com_sun_star_beans_XPropertyContainer_idl__
47#include <com/sun/star/beans/XPropertyContainer.idl>
48#endif
49
50#ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__
51#include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
52#endif
53
54#ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__
55#include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
56#endif
57
58#ifndef __com_sun_star_container_XChild_idl__
59#include <com/sun/star/container/XChild.idl>
60#endif
61
62//=============================================================================
63
64module com { module sun { module star { module ucb {
65
66//=============================================================================
67/** A TDCP Stream is a content which represents a data stream of an Office
68    document.
69
70    <p>It is  contained in a TDCP Folder or TDCP Document. A TDCP Stream has no
71    children.
72
73    @see TransientDocumentsContentProvider
74    @see TransientDocumentsRootContent
75    @see TransientDocumentsDocumentContent
76    @see TransientDocumentsFolderContent
77
78    @since OpenOffice 2.0
79*/
80service TransientDocumentsStreamContent
81{
82    //-------------------------------------------------------------------------
83    /** This interface is implemented according to the specification of
84        service <type>Content</type>.
85     */
86    interface com::sun::star::lang::XComponent;
87
88    //-------------------------------------------------------------------------
89    /** This interface is implemented according to the specification of
90        service <type>Content</type>.
91     */
92    interface com::sun::star::ucb::XContent;
93
94    //-------------------------------------------------------------------------
95    /** This interface is implemented according to the specification of
96        service <type>Content</type>.
97
98        <p>
99
100        <b>Supported Commands</b>
101        <ul>
102        <li>
103        getCommandInfo
104        </li>
105        <li>
106        getPropertySetInfo
107        </li>
108        <li>
109        getPropertyValues
110        </li>
111        <li>
112        setPropertyValues
113        </li>
114        <li>
115        open
116        </li>
117        <li>
118        insert
119        </li>
120        <li>
121        delete
122        </li>
123        </ul>
124
125        <b>Supported Properties</b>
126        <ul>
127        <li>
128        string ContentType ( read-only, always "application/vnd.sun.star.tdoc-stream" )
129        </li>
130        <li>
131        boolean IsDocument ( read-only, always true )
132        </li>
133        <li>
134        boolean IsFolder ( read-only, always false )
135        </li>
136        <li>
137        string Title
138        </li>
139        </ul>
140
141        </p>
142     */
143    interface com::sun::star::ucb::XCommandProcessor;
144
145    //-------------------------------------------------------------------------
146    /** is an enhanced version of <type>XCommandProcessor</type> that has an
147        additional method for releasing command identifiers obtained via
148        <member>XCommandProcessor::createCommandIdentifier</member> to avoid
149        resource leaks. For a detailed description of the problem refer to
150        <member>XCommandProcessor2::releaseCommandIdentifier</member>.
151
152        <p>Where many existing <type>Content</type> implementations do not
153        (yet), every new implementation should support this interface.
154     */
155    [optional] interface com::sun::star::ucb::XCommandProcessor2;
156
157    //-------------------------------------------------------------------------
158    /** This interface is implemented according to the specification of
159        service <type>Content</type>.
160     */
161    interface com::sun::star::beans::XPropertiesChangeNotifier;
162
163    //-------------------------------------------------------------------------
164    /** This interface is implemented according to the specification of
165        service <type>Content</type>.
166     */
167    interface com::sun::star::beans::XPropertyContainer;
168
169    //-------------------------------------------------------------------------
170    /** This interface is implemented according to the specification of
171        service <type>Content</type>.
172     */
173    interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
174
175    //-------------------------------------------------------------------------
176    /** This interface is implemented according to the specification of
177        service <type>Content</type>.
178     */
179    interface com::sun::star::ucb::XCommandInfoChangeNotifier;
180
181    //-------------------------------------------------------------------------
182    /** This interface is implemented according to the specification of
183        service <type>Content</type>.
184     */
185    interface com::sun::star::container::XChild;
186
187};
188
189//=============================================================================
190
191}; }; }; };
192
193#endif
194