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_PackageStreamContent_idl__
24#define __com_sun_star_ucb_PackageStreamContent_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 PCP Stream is a content which represents a file inside a package.
68
69    <p>It is always contained in a PCP Folder. A PCP Stream has no children.
70
71	@see com::sun::star::ucb::PackageContentProvider
72	@see com::sun::star::ucb::PackageFolderContent
73*/
74published service PackageStreamContent
75{
76	//-------------------------------------------------------------------------
77	/** This interface is implemented according to the specification of
78		service <type>Content</type>.
79	 */
80	interface com::sun::star::lang::XComponent;
81
82	//-------------------------------------------------------------------------
83	/** This interface is implemented according to the specification of
84		service <type>Content</type>.
85	 */
86	interface com::sun::star::ucb::XContent;
87
88	//-------------------------------------------------------------------------
89	/** This interface is implemented according to the specification of
90		service <type>Content</type>.
91
92		<p>
93
94		<b>Supported Commands</b>
95		<ul>
96		<li>
97		getCommandInfo
98		</li>
99		<li>
100		getPropertySetInfo
101		</li>
102		<li>
103		getPropertyValues
104		</li>
105		<li>
106		setPropertyValues
107		</li>
108		<li>
109		insert ( makes a newly created stream persistent )
110		</li>
111		<li>
112		delete
113		</li>
114		<li>
115		open
116		</li>
117		</ul>
118
119		<b>Supported Properties</b>
120		<ul>
121		<li>
122		string ContentType ( read-only, always "application/vnd.sun.star.pkg-stream" )
123		</li>
124		<li>
125		boolean IsDocument ( read-only, always true )
126		</li>
127		<li>
128		boolean IsFolder ( read-only, always false )
129		</li>
130		<li>
131		string MediaType
132		</li>
133		<li>
134		string Size ( read-only )
135		</li>
136		<li>
137		string Title
138		</li>
139		<li>
140		boolean Compressed ( allows you to explecitly state whether you want a
141		stream to be compressed or not. The default value of this property
142		will be determined according to the value of the property 'MediaType'.
143		If it is empty or prefixed by "text/", the value of 'Compressed' is set
144		to true. Otherwise the value will be false. )
145		</li>
146		<li>
147		boolean Encrypted ( are the stream data encrypted or not ).
148		</li>
149		</ul>
150
151		</p>
152	 */
153	interface com::sun::star::ucb::XCommandProcessor;
154
155    //-------------------------------------------------------------------------
156    /** is an enhanced version of <type>XCommandProcessor</type> that has an
157        additional method for releasing command identifiers obtained via
158        <member>XCommandProcessor::createCommandIdentifier</member> to avoid
159        resource leaks. For a detailed description of the problem refer to
160        <member>XCommandProcessor2::releaseCommandIdentifier</member>.
161
162        <p>Where many existing <type>Content</type> implementations do not
163        (yet), every new implementation should support this interface.
164     */
165    [optional] interface com::sun::star::ucb::XCommandProcessor2;
166
167	//-------------------------------------------------------------------------
168	/** This interface is implemented according to the specification of
169		service <type>Content</type>.
170	 */
171	interface com::sun::star::beans::XPropertiesChangeNotifier;
172
173	//-------------------------------------------------------------------------
174	/** This interface is implemented according to the specification of
175		service <type>Content</type>.
176	 */
177	interface com::sun::star::beans::XPropertyContainer;
178
179	//-------------------------------------------------------------------------
180	/** This interface is implemented according to the specification of
181		service <type>Content</type>.
182	 */
183	interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
184
185	//-------------------------------------------------------------------------
186	/** This interface is implemented according to the specification of
187		service <type>Content</type>.
188	 */
189	interface com::sun::star::ucb::XCommandInfoChangeNotifier;
190
191	//-------------------------------------------------------------------------
192	/** This interface is implemented according to the specification of
193		service <type>Content</type>.
194	 */
195	interface com::sun::star::container::XChild;
196};
197
198//=============================================================================
199
200}; }; }; };
201
202#endif
203