1/**************************************************************
| 1/**************************************************************
|
2 *
| 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
| 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 *
| 10 *
|
11 * http://www.apache.org/licenses/LICENSE-2.0
| 11 * http://www.apache.org/licenses/LICENSE-2.0
|
12 *
| 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.
| 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 *
| 19 *
|
20 *************************************************************/
21
| 20 *************************************************************/
21
|
22
23
| |
24#ifndef __com_sun_star_ucb_Content_idl__
25#define __com_sun_star_ucb_Content_idl__
26
27#include <com/sun/star/ucb/XContent.idl>
28#include <com/sun/star/lang/XComponent.idl>
29#include <com/sun/star/ucb/XCommandProcessor.idl>
30#include <com/sun/star/ucb/XCommandProcessor2.idl>
31#include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
32#include <com/sun/star/beans/XPropertyContainer.idl>
33#include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
34#include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
35#include <com/sun/star/ucb/XContentCreator.idl>
36#include <com/sun/star/container/XChild.idl>
37
| 22#ifndef __com_sun_star_ucb_Content_idl__
23#define __com_sun_star_ucb_Content_idl__
24
25#include <com/sun/star/ucb/XContent.idl>
26#include <com/sun/star/lang/XComponent.idl>
27#include <com/sun/star/ucb/XCommandProcessor.idl>
28#include <com/sun/star/ucb/XCommandProcessor2.idl>
29#include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
30#include <com/sun/star/beans/XPropertyContainer.idl>
31#include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
32#include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
33#include <com/sun/star/ucb/XContentCreator.idl>
34#include <com/sun/star/container/XChild.idl>
35
|
38//=============================================================================
39
| |
40module com { module sun { module star { module ucb {
41
| 36module com { module sun { module star { module ucb {
37
|
42//=============================================================================
| |
43/** A <type>Content</type> is a service that provides access to data of a
44 content provided by an implementation of the service
45 <type>ContentProvider</type>.
46*/
47published service Content
48{
| 38/** A <type>Content</type> is a service that provides access to data of a
39 content provided by an implementation of the service
40 <type>ContentProvider</type>.
41*/
42published service Content
43{
|
49 //-------------------------------------------------------------------------
| 44
|
50 /** provides access to the identitity and the type of the content and
51 allows the registration of listeners for <type>ContentEvent</type>s.
52
53 <p>This interface is required.
54 */
55 interface com::sun::star::ucb::XContent;
56
| 45 /** provides access to the identitity and the type of the content and
46 allows the registration of listeners for <type>ContentEvent</type>s.
47
48 <p>This interface is required.
49 */
50 interface com::sun::star::ucb::XContent;
51
|
57 //-------------------------------------------------------------------------
| 52
|
58 /** must be implemented to make it possible to resolve cyclic object
59 references.
60
61 <p>Those references i.e. may occure if there are listeners
62 registered at the content ( the content holds the listeners ) and
63 the implementation of the listener interface holds a reference on
64 the content. If the content shall be released,
65 <member scope="com::sun::star::lang">XComponent::dispose</member> must
66 be called at the content. The implementation of this method must call
67 <member scope="com::sun::star::lang">XEventListener::disposing</member>
68 on the registered listeners and release the appropriate object
69 references. At the other hand, the implementation of
70 XEventListener::disposing must release its appropriate references.
71
72 <p>This interface is required.
73 */
74 interface com::sun::star::lang::XComponent;
75
| 53 /** must be implemented to make it possible to resolve cyclic object
54 references.
55
56 <p>Those references i.e. may occure if there are listeners
57 registered at the content ( the content holds the listeners ) and
58 the implementation of the listener interface holds a reference on
59 the content. If the content shall be released,
60 <member scope="com::sun::star::lang">XComponent::dispose</member> must
61 be called at the content. The implementation of this method must call
62 <member scope="com::sun::star::lang">XEventListener::disposing</member>
63 on the registered listeners and release the appropriate object
64 references. At the other hand, the implementation of
65 XEventListener::disposing must release its appropriate references.
66
67 <p>This interface is required.
68 */
69 interface com::sun::star::lang::XComponent;
70
|
76 //-------------------------------------------------------------------------
| 71
|
77 /** enables the caller to let the content execute commands.
78
79 <p>It is strongly recommended that any implementation supports the
80 improved <type>XCommandProcessor2</type> interface.</p>
81
82 <p>Typical commands are "open", "delete", "getPropertyValues" and
83 "setPropertyValues". Each content must support a set of standard
84 commands and properties. Also there is a set of predefined optionally
85 commands and properties. A content may define additional commands and
86 properties. </p>
87
| 72 /** enables the caller to let the content execute commands.
73
74 <p>It is strongly recommended that any implementation supports the
75 improved <type>XCommandProcessor2</type> interface.</p>
76
77 <p>Typical commands are "open", "delete", "getPropertyValues" and
78 "setPropertyValues". Each content must support a set of standard
79 commands and properties. Also there is a set of predefined optionally
80 commands and properties. A content may define additional commands and
81 properties. </p>
82
|
88 <p>This interface is required. </p>
| 83 <p>This interface is required.</p>
|
89
| 84
|
90 <pre>
91 =======================================================================
92 Commands:
93 =======================================================================
| 85 <h3>Commands</h3>
86 <h4>Mandatory commands</h4>
|
94
| 87
|
95 [return type]
96 [command name]
97 [parameter type and name]
| 88 <table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc">
89 <thead>
90 <tr>
91 <th>Command Name</th>
92 <th>Return Type</th>
93 <th>Parameters</th>
94 <th>Description</th>
95 </tr>
96 </thead>
97 <tbody>
98 <tr>
99 <td>getCommandInfo</td>
100 <td><type>XCommandInfo</type></td>
101 <td>void</td>
102 <td>This command obtains an interface which allows to query
103 information on commands supported by a content.
104 </td>
105 </tr>
106 <tr>
107 <td>getPropertySetInfo</td>
108 <td><type scope="com::sun::star::beans">XPropertySetInfo</type></td>
109 <td>void</td>
110 <td>This command obtains an interface which allows to query
111 information on properties supported by a content.
112 </td>
113 </tr>
114 <tr>
115 <td>getPropertyValues</td>
116 <td><type scope="com::sun::star::sdbc">XRow</type></td>
117 <td>sequence< <type scope="com::sun::star::beans">Property</type> > aProps</td>
118 <td>This command obtains property values from the content.
119 <blockquote>
120 <b>Note</b>: The execution will not be aborted, if there
121 are properties requested, that are unknown to the
122 content. The returned row object must contain a NULL
123 value in the corresponding column instead.
124 </blockquote>
125 </td>
126 </tr>
127 <tr>
128 <td>setPropertyValues</td>
129 <td>sequence< any ></td>
130 <td>sequence< <type scope="com::sun::star::beans">PropertyValue</type> > aValues</td>
131 <td>This command sets property values of the content.
132 <p>Note that setPropertyValues does not throw an exception in the case
133 that one or more of the requested property values cannot be set.
134 The implementation should set as much property values as possible.</p>
|
98
| 135
|
99 -----------------------------------------------------------------------
100 Mandatory commands:
101 -----------------------------------------------------------------------
| 136 <p>This command returns a sequence< any > which has exactly the same number
137 of elements like the number of properties to set. Every sequence
138 element contains the status for a property. The first sequence
139 elements corresponds to the first element in the sequence of
140 <type scope="com::sun::star::beans">PropertyValue</type>s passed as
141 command argument, and so on. The exceptions will never be passed to
142 an <type scope="com::sun::star::task">InteractionHandler</type>.</p>
|
102
| 143
|
103 // This command obtains an interface which allows to query
104 // information on commands supported by a content.
105 <type>XCommandInfo</type>
106 getCommandInfo
107 void
| 144 <p>Every element in the returned sequence is an any containing:</p>
145 <ul>
146 <li>No value indicates, that the property value was set successfully.</li>
147 <li><type scope="com::sun::star::beans">UnknownPropertyException</type>
148 indicates, that the property is not known to the content
149 implementation.</li>
150 <li><type scope="com::sun::star::beans">IllegalTypeException</type>
151 indicates, that the data type of the property value is not
152 acceptable.</li>
153 <li><type scope="com::sun::star::lang">IllegalAccessException</type>
154 indicates, that the property is constant
155 (<member scope="com::sun::star::beans">PropertyAttribute::READONLY</member>
156 is set).</li>
157 <li><type scope="com::sun::star::lang">IllegalArgumentException</type>
158 indicates, that the property value is not acceptable. For instance,
159 setting an empty title may be illegal.</li>
160 <li>Any other execption derived from <type scope="com::sun::star::uno">Exception</type>
161 indicates, that the value was not set successfully. For example,
162 this can be a <type>InteractiveAugmentedIOException</type>
163 transporting the error code <member>IOErrorCode::ACCESS_DENIED</member>.</li>
164 </ul>
|
108
| 165
|
109 // This command obtains an interface which allows to query
110 // information on properties supported by a content.
111 <type scope="com::sun::star::beans">XPropertySetInfo</type>
112 getPropertySetInfo
113 void
| 166 <p>If the value to set is equal to the current value, no exception must
167 be added to the returned sequence</p>
168 </td>
169 </tr>
170 </tbody>
171 </table>
|
114
| 172
|
115 // This command obtains property values from the content.
116 // Note: The execution will not be aborted, if there are properties
117 // requested, that are unknown to the content! The returned
118 // row object must contain a NULL value in the corresponding
119 // column instead.
120 <type scope="com::sun::star::sdbc">XRow</type>
121 getPropertyValues
122 sequence< <type scope="com::sun::star::beans">Property</type> > aProps
| 173 <h4>Optional commands</h4>
174 <table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc">
175 <thead>
176 <tr>
177 <th>Command Name</th>
178 <th>Return Type</th>
179 <th>Parameters</th>
180 <th>Description</th>
181 </tr>
182 </thead>
183 <tbody>
184 <tr>
185 <td>open</td>
186 <td><type>XDynamicResultSet</type></td>
187 <td><type>OpenCommandArgument2</type> aOpenCommandArg</td>
188 <td>
189 For <b>folder</b> objects, this command will return an
190 implementation of service <type>DynamicResultSet</type>.
191 <p>The <type>OpenCommandArgument2</type> members must be
192 filled as follows:</p>
193 <ul>
194 <li><member scope="com::sun::star::ucb">OpenCommandArgument::Mode</member>:
195 <const scope="com::sun::star::ucb">OpenMode::ALL</const> or
196 <const scope="com::sun::star::ucb">OpenMode::FOLDERS</const> or
197 <const scope="com::sun::star::ucb">OpenMode::DOCUMENTS</const>.
198 The implementation of the open command MUST support all these modes!
199 </li>
200 <li><member scope="com::sun::star::ucb">OpenCommandArgument::Priority</member>:
201 can be set, but implementation may ignore the value
202 </li>
203 <li><member scope="com::sun::star::ucb">OpenCommandArgument::Sink</member>:
204 empty( ignored )
205 </li>
206 <li><member scope="com::sun::star::ucb">OpenCommandArgument::Properties</member>:
207 The properties for which the result set shall
208 contain the property values. The order of the
209 sequence is the same as the order of result set
210 columns. First element of sequence will be row
211 number one, second will be row number two, ...
212 </li>
213 <li><member scope="com::sun::star::ucb">OpenCommandArgument2::SortingInfo</member>:
214 contains sort criteria, if result set shall
215 be sorted, otherwise it can be left empty.
216 </li>
217 </ul>
218 The exceution must be aborted by the implementation of this command
219 (by throwing a <type>CommandAbortedException</type>), if an
220 unsupported mode is requested.
221 </td>
222 </tr>
223 <tr>
224 <td>open</td>
225 <td>void</td>
226 <td><type>OpenCommandArgument2</type> aOpenCommandArg</td>
227 <td>For non-folder objects, the <type>OpenCommandArgument2</type>
228 struct will be prefilled with a data sink object, which
229 will be filled with the content data.
230 <p>The <type>OpenCommandArgument2</type> members must be
231 filled as follows:</p>
232 <ul>
233 <li><member scope="com::sun::star::ucb">OpenCommandArgument::Mode</member>:
234 <const scope="com::sun::star::ucb">OpenMode::DOCUMENT</const> or
235 <const scope="com::sun::star::ucb">OpenMode::DOCUMENT_SHARE_DENY_NONE</const> or
236 <const scope="com::sun::star::ucb">OpenMode::DOCUMENT_SHARE_DENY_WRITE</const>.
237 Support for DOCUMENT is mandatory, all others are optional.
238 </li>
239 <li><member scope="com::sun::star::ucb">OpenCommandArgument::Priority</member>:
240 can be set, but implementation may ignore the value
241 </li>
242 <li><member scope="com::sun::star::ucb">OpenCommandArgument::Sink</member>:
243 a sink, where the implementation can put the document data into.
244 </li>
245 <li><member scope="com::sun::star::ucb">OpenCommandArgument::Properties</member>: empty ( ignored )</li>
246 <li><member scope="com::sun::star::ucb">OpenCommandArgument2::SortingInfo</member>: empty ( ignored )</li>
247 </ul>
248 <p>The exceution must be aborted by the implementation of this command
249 (by throwing a <type>CommandAbortedException</type>), if an
250 unsupported mode is requested.</p>
251 </td>
252 </tr>
253 <tr>
254 <td>createNewContent</td>
255 <td><type>XContent</type></td>
256 <td><type>ContentInfo</type> contentinfo</td>
257 <td>
258 This command creates a new <b>non-persistent</b> content of a given type.
259 <p>This command must be supported by every <type>Content</type>
260 that supports the property "CreatableContentsInfo", if the returned
261 property value contains a non-empty sequence of creatable types.
262 <blockquote>
263 Note: This command is part of the replacement for the deprecated
264 interface <type>XContentCreator</type>.
265 </blockquote>
266 <p>Creation of a new <b>persistent</b> content:
267 <ol>
268 <li>creatabletypes = obtain "CreatableContentsInfo" property from creator</li>
269 <li>choose a suitable type from creatabletypes</li>
270 <li>newObject = execute command "createNewContent(type)" at creator</li>
271 <li>initialize the new object (i.e. newObject.Property1 = ...)</li>
272 <li>execute command "insert" at new content. This command
273 commits the data and makes the new content persistent.</li>
274 </ol>
275 </td>
276 </tr>
277 <tr>
278 <td>insert</td>
279 <td>void</td>
280 <td><type>InsertCommandArgument</type> aInsertCommandArg</td>
281 <td>
282 <ol>
283 <li>
284 This command inserts a <b>new content</b>. It commits the process of
285 creating a new content via executing the command "createNewContent"
286 and initializing it via setting properties, afterwards.</br>
287 The command is not called on the content which created the new
288 content, because the new object already knows where it is to be
289 inserted (i.e. Calling createNewContent with the content type for a
290 message on a News Group creates a content which internally belongs
291 to the Outbox. Calling "insert" on that message will result in
292 posting the article to the appropriate News Group). Not calling
293 "insert" for the new content, i.e. because the user cancels writing
294 a new message, simply discards the new object. No extra call to
295 "delete" is necessary.</br>
296 On successful completion of this command, the parent of the inserted
297 content must propagate the change by notifying a
298 <type>ContentEvent</type> - <member>ContentAction::INSERTED</member>.
299 </li>
300 <li>
301 Additionally this command can be called at any time to overwrite
302 the data of an <b>existing content</b>.
303 </li>
304 </ol>
305 </td>
306 </tr>
307 <tr>
308 <td>update</td>
309 <td>void</td>
310 <td><type>OpenCommandArgument2</type> aOpenCommandArg</td>
311 <td>This command triggers an update operation on a content.
312 For example, when "updating" a POP3-Inbox, the content
313 for that box will get and store all new objects on the
314 appropriate server. The inserted contents will be
315 notified by calling
316 <member>XContentEventListener::contentEvent</member>.
317 </td>
318 </tr>
319 <tr>
320 <td>synchronize</td>
321 <td>void</td>
322 <td><type>OpenCommandArgument2</type> aOpenCommandArg</td>
323 <td>
324 This command triggers a synchronization operation between locally
325 cached data and remote server's data. For example, when
326 "synchronizing" a POP3-Inbox the content for that box will get and
327 store all new objects and destroy all cached data for objects no
328 longer existing on the server. The inserted/deleted contents will
329 be notified by calling
330 <member>XContent::contentEvent</member>.
331 </td>
332 </tr>
333 <tr>
334 <td>close</td>
335 <td>void</td>
336 <td>void</td>
337 <td>This command closes an object.</td>
338 </tr>
339 <tr>
340 <td>delete</td>
341 <td>void</td>
342 <td>boolean bDeletePhysically</td>
343 <td>
344 This command deletes an object. If <TRUE/> is passed as parameter,
345 the object will be destroyed physically. Otherwise it will be put
346 into trash can, if such a service is available and the object to
347 be deleted supports the command "undelete".
348 On successful completion of this command, the deleted content
349 must propagate its deletion by notifying a <type>ContentEvent</type>
350 - <member>ContentAction::DELETED</member>. Additionally, the contents
351 parent must notify a <type>ContentEvent</type>
352 - <member>ContentAction::REMOVED</member>
353 </td>
354 </tr>
355 <tr>
356 <td>undelete</td>
357 <td>void</td>
358 <td>void</td>
359 <td>
360 This command restores an object previously deleted into trash. It
361 must be supported by objects which claim to be undeletable, but
362 should never be called directly.
363 </td>
364 </tr>
365 <tr>
366 <td>search</td>
367 <td><type>XDynamicResultSet</type></td>
368 <td><type>SearchCommandArgument</type> aSearchCommandArg</td>
369 <td>
370 This command searches for subcontents of a content matching the
371 given search criteria. The command will return an implemenation
372 of service <type>DynamicResultSet</type>.
373 </td>
374 </tr>
375 <tr>
376 <td>transfer</td>
377 <td>void</td>
378 <td><type>TransferInfo</type> aTransferInfo</td>
379 <td>
380 <blockquote>
381 <b>Important note:</b> A client that wants to transfer data should
382 not execute this command, but it should execute the command
383 "globalTransfer" at the <type>UniversalContentBroker</type>.
384 This command is able to transfer all kind of content
385 supported by that UCB.
386 </blockquote>
387 This command transfers (copies/moves) an object from one location
388 to another. It must be executed at the folder content representing
389 the <b>destination</b> of the transfer operation.</br>
390 Note that the implementation need not be able to handle
391 any type of contents.</br>
392 Generally, there are good chances that a transfer of a content will
393 succeed, if source and target folder have the same URL scheme.
394 But there is no guaranty for that.</br>
395 For instance, moving a message from a folder on IMAP server A
396 to a folder on IMAP server B may fail, because the transfer
397 command can't be implemented efficiently for this scenario,
398 because it is not directly supported by the IMAP protocol.
399 On the other hand, moving a message from one folder to
400 another folder on the same IMAP server should work, because it can
401 be implemeted efficiently.</br>
402 If an implementation is not able to handle a given source URL,
403 it should indicate this by issuing a
404 <type>InteractiveBadTransferURLException</type> interaction request.</br>
405 Source and target folder may be the same when doing a move operation.
406 </br>
407 Transfers without the transfer command can be done as follows:
408 <ol>
409 <li>Create a new content at the target folder</br>
410 <code>targetContent = target.execute( "createNewContent", type )</code>
411 </li>
412 <li>Transfer data from source to target content</br>
413 <code>props = sourceContent.execute( "getPropertyValues", ... )</code>
414 <code>dataStream = sourceContent.execute( "open", ... )</code>
415 <code>targetContent.execute( "setPropertyValues", props )</code>
416 </li>
417 <li>Insert ( commit ) the new content</br>
418 <code>targetContent.execute( "insert", dataStream )</code>
419 </li>
420 <li>For move operations only: destroy the source content</br>
421 <code>sourceContent.execute( "delete", ... )</code>
422 </li>
423 </ol>
424 <p>This mechanism should work for all transfer operations, but generally
425 it's less efficient than the transfer command.</p>
426 </td>
427 </tr>
428 <tr>
429 <td>lock</td>
430 <td>void</td>
431 <td>void</td>
432 <td>
433 This command obtains an exlusive write lock for the resource. The
434 lock is active until command "unlock" is executed, or the OOo
435 session that obtained the lock ends, or until the lock is released by
436 a third party (e.g. a system administrator).</br>
437 Exceptions:
438 <ul>
439 <li><type>InteractiveLockingLockedException</type></li>
440 <li><type>InteractiveLockingLockExpiredException</type></li>
441 </ul>
442 </td>
443 </tr>
444 <tr>
445 <td>unlock</td>
446 <td>void</td>
447 <td>void</td>
448 <td>
449 This command removes a lock obtained by executing the command "lock"
450 from the resource.</br>
451 <p>Exceptions:
452 <ul>
453 <li><type>InteractiveLockingLockedException</type></li>
454 <li><type>InteractiveLockingLockExpiredException</type></li>
455 </ul>
456 </p>
457 <p>Note that <type>InteractiveLockingLockExpiredException</type> might
458 be raised by any command that requires a previously obtained lock.
459 </p>
460 </td>
461 </tr>
462 </tbody>
463 </table>
|
123
| 464
|
124 // This command sets property values of the content.
125 // Note that setPropertyValues does not throw an exception in the case
126 // that one or more of the requested property values cannot be set! The
127 // implementation should set as much property values as possible. This
128 // command returns a sequence< any > which has exactly the same number
129 // of elements like the number of properties to set. Every sequence
130 // element contains the status for a property. The first sequence
131 // elements corresponds to the first element in the sequence of
132 // <type scope="com::sun::star::beans">PropertyValue</type> passed as
133 // command argument and so on. The exceptions will never be passed to
134 // an Interaction Handler.
135 //
136 // An any containing:
137 //
138 // - No value indicates, that the property value was set successfully.
139 // - <type scope="com::sun::star::beans">UnknownPropertyException</type>
140 // indicates, that the property is not known to the content
141 // implementation.
142 // - <type scope="com::sun::star::beans">IllegalTypeException</type>
143 // indicates, that the data type of the property value is not
144 // acceptable.
145 // - <type scope="com::sun::star::lang">IllegalAccessException</type>
146 // indicates, that the property is constant
147 // (<member scope="com::sun::star::beans">PropertyAttribute::READONLY</member>
148 // is set).
149 // - <type scope="com::sun::star::lang">IllegalArgumentException</type>
150 // indicates, that the property value is not acceptable. For instance,
151 // setting an empty title may be illegal.
152 // - Any other execption derived from <type scope="com::sun::star::uno">Exception</type>
153 // indicates, that the value was not set successfully. For example,
154 // this can be a <type>InteractiveAugmentedIOException</type>
155 // transporting the error code <member>IOErrorCode::ACCESS_DENIED</member>.
156 //
157 // If the value to set is equal to the current value, no exception must
158 // be added to the returned sequence
159 sequence< any >
160 setPropertyValues
161 sequence< <type scope="com::sun::star::beans">PropertyValue</type> > aValues
| 465 <h3>Properties</h3>
466 <h4>Mandatory properties</h4>
|
162
| 467
|
163 -----------------------------------------------------------------------
164 Optional commands:
165 -----------------------------------------------------------------------
| 468 <table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc">
469 <thead>
470 <tr>
471 <th>Name</th>
472 <th>Type</th>
473 <th>Description</th>
474 </tr>
475 </thead>
476 <tbody>
477 <tr>
478 <td>ContentType</td>
479 <td>string</td>
480 <td>
481 contains a unique type string for the content
482 ( i.e. "application/vnd.sun.star.hierarchy-link" ).
483 <p>This property is always read-only.</p>
484 <p>The ContentType should not be confused with the MIME
485 media type ( MIME types ) of the content. Media types
486 may be provided through the optional property "MediaType".</p>
487 <p>The value of this property should match the information on creatable
488 contents given by UCB contents that implement the property
489 "CreatableContentsInfo".</p>
490 </td>
491 </tr>
492 <tr>
493 <td>IsFolder</td>
494 <td>boolean</td>
495 <td>indicates, whether a content can contain other contents.</td>
496 </tr>
497 <tr>
498 <td>IsDocument</td>
499 <td>boolean</td>
500 <td>indicates, whether a content is a document. This means,
501 the content can dump itself into a data sink.
502 </td>
503 </tr>
504 <tr>
505 <td>Title</td>
506 <td>string</td>
507 <td>contains the title of an object (e.g. the subject of a message).</td>
508 </tr>
509 </tbody>
510 </table>
|
166
| 511
|
167 // For folder objects, this command will return an implementation
168 // of service <type>DynamicResultSet</type>.
169 //
170 // The <type>OpenCommandArgument2</type> members must be filled as follows:
171 //
172 // Mode : ALL or FOLDERS or DOCUMENTS. The implementation
173 // of the open command MUST support all these modes!
174 // Priority : can be set, but implementation may ignore the value
175 // Sink : empty( ignored )
176 // Properties : The properties for that the result set shall
177 // contain the property values. The order of the
178 // sequence is the same as the order of result set
179 // columns. First element of sequence will be row
180 // number one, second will be row number two, ...
181 // SortingInfo : contains sort criteria, if result set shall
182 // be sorted, otherwise it can be left empty.
183 //
184 // The exceution must be aborted by the implementation of this command
185 // (by throwing a <type>CommandAbortedException</type>), if an
186 // unsupported mode is requested.
187 <type>XDynamicResultSet</type>
188 <B>open</B>
189 <type>OpenCommandArgument2</type> aOpenCommandArg
| 512 <h4>Optional properties</h4>
|
190
| 513
|
191 // For non-folder objects, the <type>OpenCommandArgument2</type> struct
192 // will be prefilled with a data sink object, which will be filled
193 // with the content data.
194 //
195 // The <type>OpenCommandArgument2</type> members must be filled as follows:
196 //
197 // Mode : DOCUMENT or DOCUMENT_SHARE_DENY_NONE or
198 // DOCUMENT_SHARE_DENY_WRITE. Support for DOCUMENT
199 // is mandatory, all others are optional.
200 // Priority : can be set, but implementation may ignore the value
201 // Sink : a sink, where the implementation can put the
202 // document data into.
203 // Properties : empty ( ignored )
204 // SortingInfo : empty ( ignored )
205 //
206 // The exceution must be aborted by the implementation of this command
207 // (by throwing a <type>CommandAbortedException</type>), if an
208 // unsupported mode is requested.
209 void
210 <B>open</B>
211 <type>OpenCommandArgument2</type> aOpenCommandArg
212
213 // This command triggers an update operation on a content. For example,
214 // when "updating" a POP3-Inbox, the content for that box will get
215 // and store all new objects on the appropriate server. The inserted
216 // contents will be notified by calling
217 // <member>XContentEventListener::contentEvent</member>.
218 void
219 <B>update</B>
220 <type>OpenCommandArgument2</type> aOpenCommandArg
221
222 // This command triggers a synchronization operation between locally
223 // cached data and remote server's data. For example, when
224 // "synchronizing" a POP3-Inbox the content for that box will get and
225 // store all new objects and destroy all cached data for objects no
226 // longer existing on the server. The inserted/deleted contents will
227 // be notified by calling
228 // <member>XContent::contentEvent</member>.
229 void
230 <B>synchronize</B>
231 <type>OpenCommandArgument2</type> aOpenCommandArg
232
233 // This command closes an object.
234 void
235 <B>close</B>
236 void
237
238 // This command deletes an object. If <TRUE/> is passed as parameter,
239 // the object will be destroyed physically. Otherwise it will be put
240 // into trash can, if such a service is available and the object to
241 // be deleted supports the command "undelete".
242 // On successful completion of this command, the deleted content
243 // must propagate its deletion by notifying a <type>ContentEvent</type>
244 // - <member>ContentAction::DELETED</member>. Additionally, the contents
245 // parent must notify a <type>ContentEvent</type>
246 // - <member>ContentAction::REMOVED</member>
247 void
248 <B>delete</B>
249 boolean bDeletePhysically
250
251 // This command restores an object previously deleted into trash. It
252 // must be supported by objects which claim to be undeletable, but
253 // should never be called directly.
254 void
255 <B>undelete</B>
256 void
257
258 // (1) This command inserts a new content. It commits the process of
259 // creating a new content via executing the command "createNewContent"
260 // and initializing it via setting properties, afterwards.
261 // The command is not called on the content which created the new
262 // content, because the new object already knows where it is to be
263 // inserted (i.e. Calling createNewContent with the content type for a
264 // message on a News Group creates a content which internally belongs
265 // to the Outbox. Calling "insert" on that message will result in
266 // posting the article to the appropriate News Group). Not calling
267 // "insert" for the new content, i.e. because the user cancels writing
268 // a new message, simply discards the new object. No extra call to
269 // "delete" is necessary.
270 // On successful completion of this command, the parent of the inserted
271 // content must propagate the change by notifying a
272 // <type>ContentEvent</type> - <member>ContentAction::INSERTED</member>.
273 //
274 // (2) Additionally this command can be called at any time to overwrite
275 // the data of an existing content.
276 void
277 <B>insert</B>
278 <type>InsertCommandArgument</type> aInsertCommandArg
279
280 // This command searches for subcontents of a content matching the
281 // given search criteria. The command will return an implemenation
282 // of service <type>DynamicResultSet</type>.
283 <type>XDynamicResultSet</type>
284 <B>search</B>
285 <type>SearchCommandArgument</type> aSearchCommandArg
286
287 // <b>Important note:</b> A client that wants to transfer data should
288 // not execute this command, but it should execute the command
289 // "globalTransfer" at the <type>UniversalContentBroker</type>.
290 // This command is able to transfer all kind of content
291 // supported by that UCB.
292 //
293 // This command transfers (copies/moves) an object from one location
294 // to another. It must be executed at the folder content representing
295 // the destination of the transfer operation. Note that the
296 // implementation need not(!) be able to handle any type of contents.
297 // Generally, there are good chances that a transfer of a content will
298 // succeed, if source and target folder have the same URL scheme.
299 // But there is no guaranty for that. For instance, moving a message
300 // from a folder on IMAP server A to a folder on IMAP server B may
301 // fail, because the transfer command can't be implemented efficiently
302 // for this scenario, because it is not directly supported by the IMAP
303 // protocol. On the other hand, moving a message from one folder to
304 // another folder on the same IMAP server should work, because it can
305 // be implemeted efficiently. If an implementation is not able to
306 // handle a given source URL, it should indicate this by issuing a
307 // <type>InteractiveBadTransferURLException</type> interaction request.
308 // Source and target folder may be the same when doing a move operation.
309 //
310 // Transfers without the transfer command can be done as follows:
311 //
312 // 1) Create a new content at the target folder
313 // --> targetContent = target.execute( "createNewContent", type )
314 // 2) Transfer data from source to target content
315 // --> props = sourceContent.execute( "getPropertyValues", ... )
316 // --> dataStream = sourceContent.execute( "open", ... )
317 // --> targetContent.execute( "setPropertyValues", props )
318 // 3) Insert ( commit ) the new content
319 // --> targetContent.execute( "insert", dataStream )
320 // 4) For move operations only: destroy the source content
321 // sourceContent.execute( "delete", ... )
322 //
323 // This mechanism should work for all transfer operations, but generally
324 // it's less efficient than the transfer command.
325 void
326 <B>transfer</B>
327 <type>TransferInfo</type> aTransferInfo
328
329 // This command obtains an exlusive write lock for the resource. The
330 // lock is active until command "unlock" is executed or the OOo
331 // session that obtained the lock ends or until the lock is released by
332 // a third party (e.g. a system administrator).
333 void
334 <B>lock</B>
335 void
336 Exceptions: <type>InteractiveLockingLockedException</type>
337 <type>InteractiveLockingLockExpiredException</type>
338
339 // This command removes a lock obtained by executing the command "lock"
340 // from the resource.
341 void
342 <B>unlock</B>
343 void
344 Exceptions: <type>InteractiveLockingNotLockedException</type>
345 <type>InteractiveLockingLockExpiredException</type>
346
347 // Note that <type>InteractiveLockingLockExpiredException</type> might
348 // be raised by any command that requires a previously obtained lock.
349
350 // This command creates a new non-persistent content of a given type.
351 //
352 // <p>Creation of a new (persistent) content:
353 // <ol>
354 // <li>creatabletypes = obtain "CreatableContentsInfo" property<br>
355 // from creator
356 // <li>choose a suitable type from creatabletypes
357 // <li>newObject = execute command "createNewContent(type)" at<br>
358 // creator
359 // <li>initialize the new object (i.e. newObject.Property1 = ...)
360 // <li>execute command "insert" at new content. This command
361 // commits the data and makes the new content persistent.
362 // </ol>
363 //
364 // This command must be supported by every Content that supports the
365 // property "CreatableContentsInfo" if the returned property value
366 // contains a non-empty sequence of creatable types.
367 //
368 // Note: This command is part of the replacement for the deprecated
369 // interface <type>XContentCreator</type>.
370 <type>XContent</type> >
371 <B>createNewContent</B>
372 <type>ContentInfo<type> contentinfo
373
374 =======================================================================
375 Properties:
376 =======================================================================
377
378 -----------------------------------------------------------------------
379 Mandatory properties:
380 -----------------------------------------------------------------------
381
382 // contains a unique(!) type string for the content ( i.e.
383 // "application/vnd.sun.star.hierarchy-link" ). This property is always
384 // read-only. It does not contain the media type ( MIME types ) of the
385 // content. Media types may be provided through the optional property
386 // "MediaType".
387 // The value of this property should match the information on creatable
388 // contents given by UCB contents that implement the property
389 // "CreatableContentsInfo".
390 string ContentType
391
392 // indicates, whether a content can contain other contents.
393 boolean IsFolder
394
395 // indicates, whether a content is a document. This means, the
396 // content can dump itself into a data sink.
397 boolean IsDocument
398
399 // contains the title of an object (e.g. the subject of a message).
400 string Title;
401
402 -----------------------------------------------------------------------
403 Optional properties:
404 -----------------------------------------------------------------------
405
406 // contains the interval for automatic updates of an object.
407 // It is specified in seconds.
408 long AutoUpdateInterval
409
410 // contains the maximum number of network connections
411 // allowed for one (internet) protocol at a time. (e.g. The HTTP
412 // cache can be configured to use a maximum for the number of
413 // connections used for browsing.)
414 short ConnectionLimit
415
416 // contains the current connection mode for the object.
417 // (see <type>ConnectionMode</type>)
418 short ConnectionMode
419
420 // contains the date and time the object was created.
421 <type scope"com::sun::star::util">DateTime</type> DateCreated
422
423 // contains the date and time the object was last modified.
424 <type scope"com::sun::star::util">DateTime</type> DateModified
425
426 // contains the count of documents of a folder.
427 long DocumentCount;
428
429 // contains the count of marked documents within a folder.
430 long DocumentCountMarked
431
432 // contains a sequence of documemt header fields (i.e. header
433 // fields of a MIME-message, or the document info of an
434 // office document ). For some standard header fields there
435 // are predefined separate properties, like "MessageTo".
436 sequence< <type>DocumentHeaderField</type> > DocumentHeader
437
438 // contains information about the way a folder stores the
439 // contents of (remote) documents.
440 <type>DocumentStoreMode</type> DocumentStoreMode
441
442 // contains the count of subfolders of a folder.
443 long FolderCount
444
445 // contains the free space left on a storage device. It is
446 // specified in bytes.
447 hyper FreeSpace
448
449 // indicates whether a content has subcontents, which are documents.
450 boolean HasDocuments
451
452 // indicates whether a content has subcontents, which are folders.
453 boolean HasFolders
454
455 // indicates whether a content is "marked".
456 boolean IsMarked
457
458 // indicates whether a content has been "read".
459 boolean IsRead;
460
461 // indicates whether a content is read-only.
462 boolean IsReadOnly
463
464 // indicates whether a content is subscribed.
465 boolean IsSubscribed
466
467 // indicates whether the feature to store contents depending on
468 // their age is active.
469 boolean IsTimeLimitedStore;
470
471 // indicates whether (sub)contents shall be automatically updated
472 // everytime a (folder) content is opened. This property may be
473 // used to control whether a folder content should read data only
474 // from local cache when it is opened, or whether it should connect
475 // to a server to obtain latest data.
476 boolean UpdateOnOpen
477
478 // contains the keywords of a document (e.g. the value
479 // of the "keywords" header field of a news article).
480 string Keywords
481
482 // contains the media type ( MIME type ) of a content. It is highly
483 // recommended to support this property if the content's implementation
484 // can obtain the media type natively from its data source ( i.e.
485 // HTTP servers provide media types for all their documents ).
486 string MediaType
487
488 // contains the BCC (blind carbon copy) receiver(s) of a message.
489 string MessageBCC
490
491 // contains the CC (carbon copy) receiver(s) of a message.
492 string MessageCC
493
494 // contains (the address of) the sender of a message.
495 string MessageFrom
496
497 // contains the ID of a message.
498 string MessageId
499
500 // contains the "In-Reply-To" field of a message.
501 string MessageInReplyTo
502
503 // contains the "Reply-To" field of a message.
504 string MessageReplyTo
505
506 // contains the recipient(s) of a message.
507 string MessageTo
508
509 // contains the name(s) of the newsgroup(s) into which a message
510 // was posted.
511 string NewsGroups
512
513 // contains a password (e.g. needed to access a POP3-Server).
514 string Password
515
516 // contains a priority (i.e. of a message).
517 <type>Priority</type> Priority
518
519 // contains the "References" field of a news article.
520 string References
521
522 // contains the rules set for a content.
523 <type>RuleSet</type> Rules
524
525 // contains the count of seen/read subcontents of a folder content.
526 long SeenCount
527
528 // contains the base directory to use on a server. (e.g. Setting
529 // the server base of an FTP-Account to "/pub/incoming"
530 // will result in showing contents from that directory and not from
531 // server's root directory)
532 string ServerBase
533
534 // contains a server name (e.g. The name of the server to use for
535 // a POP3-Account).
536 string ServerName
537
538 // contains a numeric server port.
539 short ServerPort
540
541 // contains the size (usually in bytes) of an object.
542 hyper Size
543
544 // contains a size limit for an object. (e.g. One may specify the
545 // maximum size of the HTTP-Cache)
546 hyper SizeLimit
547
548 // contains the count of subscribed contents of a folder.
549 long SubscribedCount
550
551 // contains the policy to use when synchronizing two objects.
552 <type>SynchronizePolicy</type> SynchronizePolicy
553
554 // contains information about the target frame to use when displaying
555 // an object.
556
557 <p>The value is a string containing three tokens, separated by ";"
558 (A semicolon):<br/>
559 <dl>
560 <dt>1st token
561 </dt><dd>Behavior on "select" ( single click )
562 </dd><dt>2nd token
563 </dt><dd>Behavior on "open" ( double click )
564 </dd><dt>3rd token
565 </dt><dd>Behavior on "open in new task" ( double click + CTRL key )
566 </dd></dl>
567 </p>
568 <p> Each token may contain the following values:<br/>
569 <dl>
570 <dt>"_beamer"
571 </dt><dd>Show in "Beamer"
572 </dd><dt>"_top"
573 </dt><dd>Show in current frame (replaces old)
574 </dd><dt>"_blank"
575 </dt><dd>Show in new task
576 </dd></dl>
577 </p>
578 string TargetFrames
579
580 // for contents that are links to other contents, contains the URL of
581 // the target content
582 string TargetURL
583
584 // contains the value to use if the property "IsTimeLimitedStore" is set.
585 short TimeLimitStore;
586
587 // contains a user name. (e.g. the user name needed to access a
588 // POP3-Account)
589 string UserName
590
591 // describes a verification policy.
592 <type>VerificationMode</type> VerificationMode
593
594 // contains the types of Contents a Content object can create via
595 // command "createNewContent".
596 //
597 // If the property value can be a non-empty sequence, the Content must
598 // also support command "createNewContent".
599 //
600 // Note: This property is part of the replacement for the deprecated
601 // interface <type>XContentCreator</type>.
602 sequence <type>ContentInfo</type> CreatableContentsInfo
603
604 </pre>
| 514 <table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc">
515 <thead>
516 <tr>
517 <th>Name</th>
518 <th>Type</th>
519 <th>Description</th>
520 </tr>
521 </thead>
522 <tbody>
523 <tr>
524 <td>AutoUpdateInterval</td>
525 <td>long</td>
526 <td>contains the interval for automatic updates of an object.
527 It is specified in seconds.
528 </td>
529 </tr>
530 <tr>
531 <td>ConnectionLimit</td>
532 <td>short</td>
533 <td>contains the maximum number of network connections
534 allowed for one (internet) protocol at a time. (e.g. The HTTP
535 cache can be configured to use a maximum for the number of
536 connections used for browsing.)
537 </td>
538 </tr>
539 <tr>
540 <td>ConnectionMode</td>
541 <td>short</td>
542 <td>contains the current connection mode for the object.
543 (see <type>ConnectionMode</type>)
544 </td>
545 </tr>
546 <tr>
547 <td>CreatableContentsInfo</td>
548 <td>sequence <type>ContentInfo</type></td>
549 <td>
550 contains the types of Contents a Content object can create via
551 command "createNewContent".
552 <p>If the property value can be a non-empty sequence, the
553 Content must also support command "createNewContent".</p>
554 <blockquote>
555 Note: This property is part of the replacement for the deprecated
556 interface <type>XContentCreator</type>.
557 </blockquote>
558 </td>
559 </tr>
560 <tr>
561 <td>DateCreated</td>
562 <td><type scope"com::sun::star::util">DateTime</type></td>
563 <td>contains the date and time the object was created.</td>
564 </tr>
565 <tr>
566 <td>DateModified</td>
567 <td><type scope"com::sun::star::util">DateTime</type></td>
568 <td>contains the date and time the object was last modified.</td>
569 </tr>
570 <tr>
571 <td>DocumentCount</td>
572 <td>long</td>
573 <td>contains the count of documents of a folder.</td>
574 </tr>
575 <tr>
576 <td>DocumentCountMarked</td>
577 <td>long</td>
578 <td>contains the count of marked documents within a folder.</td>
579 </tr>
580 <tr>
581 <td>DocumentHeader</td>
582 <td>sequence< <type>DocumentHeaderField</type> > </td>
583 <td>contains a sequence of documemt header fields (i.e. header
584 fields of a MIME-message, or the document info of an
585 office document ). For some standard header fields there
586 are predefined separate properties, like "MessageTo".
587 </td>
588 </tr>
589 <tr>
590 <td>DocumentStoreMode</td>
591 <td><type>DocumentStoreMode</type></td>
592 <td>contains information about the way a folder stores the
593 contents of (remote) documents.
594 </td>
595 </tr>
596 <tr>
597 <td>FolderCount</td>
598 <td>long</td>
599 <td>contains the count of subfolders of a folder.</td>
600 </tr>
601 <tr>
602 <td>FreeSpace</td>
603 <td>hyper</td>
604 <td>contains the free space left on a storage device. It is
605 specified in bytes.</td>
606 </tr>
607 <tr>
608 <td>HasDocuments</td>
609 <td>boolean</td>
610 <td>indicates whether a content has subcontents, which are documents.</td>
611 </tr>
612 <tr>
613 <td>HasFolders</td>
614 <td>boolean</td>
615 <td>indicates whether a content has subcontents, which are folders.</td>
616 </tr>
617 <tr>
618 <td>IsMarked</td>
619 <td>boolean</td>
620 <td>indicates whether a content is "marked".</td>
621 </tr>
622 <tr>
623 <td>IsRead</td>
624 <td>boolean</td>
625 <td>indicates whether a content has been "read".</td>
626 </tr>
627 <tr>
628 <td>IsReadOnly</td>
629 <td>boolean</td>
630 <td>indicates whether a content is read-only.</td>
631 </tr>
632 <tr>
633 <td>IsSubscribed</td>
634 <td>boolean</td>
635 <td>indicates whether a content is subscribed.</td>
636 </tr>
637 <tr>
638 <td>IsTimeLimitedStore</td>
639 <td>boolean</td>
640 <td>indicates whether the feature to store contents
641 depending on their age is active.</td>
642 </tr>
643 <tr>
644 <td>UpdateOnOpen</td>
645 <td>boolean</td>
646 <td>indicates whether (sub)contents shall be automatically updated
647 everytime a (folder) content is opened.</br>This property may be
648 used to control whether a folder content should read data only
649 from local cache when it is opened, or whether it should connect
650 to a server to obtain latest data.</td>
651 </tr>
652 <tr>
653 <td>Keywords</td>
654 <td>string</td>
655 <td>contains the keywords of a document (e.g. the value
656 of the "keywords" header field of a news article).</td>
657 </tr>
658 <tr>
659 <td>MediaType</td>
660 <td>string</td>
661 <td>contains the media type ( MIME type ) of a content. It is highly
662 recommended to support this property if the content's implementation
663 can obtain the media type natively from its data source ( i.e.
664 HTTP servers provide media types for all their documents ).
665 </td>
666 </tr>
667 <tr>
668 <td>MessageBCC</td>
669 <td>string</td>
670 <td>contains the BCC (blind carbon copy) receiver(s) of a message.</td>
671 </tr>
672 <tr>
673 <td>MessageCC</td>
674 <td>string</td>
675 <td>contains the CC (carbon copy) receiver(s) of a message.</td>
676 </tr>
677 <tr>
678 <td>MessageFrom</td>
679 <td>string</td>
680 <td>contains (the address of) the sender of a message.</td>
681 </tr>
682 <tr>
683 <td>MessageId</td>
684 <td>string</td>
685 <td>contains the ID of a message.</td>
686 </tr>
687 <tr>
688 <td>MessageInReplyTo</td>
689 <td>string</td>
690 <td>contains the "In-Reply-To" field of a message.</td>
691 </tr>
692 <tr>
693 <td>MessageReplyTo</td>
694 <td>string</td>
695 <td>contains the "Reply-To" field of a message.</td>
696 </tr>
697 <tr>
698 <td>MessageTo</td>
699 <td>string</td>
700 <td>contains the recipient(s) of a message.</td>
701 </tr>
702 <tr>
703 <td>NewsGroups</td>
704 <td>string</td>
705 <td>contains the name(s) of the newsgroup(s) into which a message was posted.</td>
706 </tr>
707 <tr>
708 <td>Password</td>
709 <td>string</td>
710 <td>contains a password (e.g. needed to access a POP3-Server).</td>
711 </tr>
712 <tr>
713 <td>Priority</td>
714 <td><type>Priority</type></td>
715 <td>contains a priority (i.e. of a message).</td>
716 </tr>
717 <tr>
718 <td>References</td>
719 <td>string</td>
720 <td>contains the "References" field of a news article.</td>
721 </tr>
722 <tr>
723 <td>Rules</td>
724 <td><type>RuleSet</type></td>
725 <td>contains the rules set for a content.</td>
726 </tr>
727 <tr>
728 <td>SeenCount</td>
729 <td>long</td>
730 <td>contains the count of seen/read subcontents of a folder content.</td>
731 </tr>
732 <tr>
733 <td>ServerBase</td>
734 <td>string</td>
735 <td>contains the base directory to use on a server. (e.g. Setting
736 the server base of an FTP-Account to "/pub/incoming"
737 will result in showing contents from that directory and not from
738 server's root directory)
739 </td>
740 </tr>
741 <tr>
742 <td>ServerName</td>
743 <td>string</td>
744 <td>contains a server name (e.g. The name of the server to use for
745 a POP3-Account).
746 </td>
747 </tr>
748 <tr>
749 <td>ServerPort</td>
750 <td>short</td>
751 <td>contains a numeric server port.</td>
752 </tr>
753 <tr>
754 <td>Size</td>
755 <td>hyper</td>
756 <td>contains the size (usually in bytes) of an object.</td>
757 </tr>
758 <tr>
759 <td>SizeLimit</td>
760 <td>hyper</td>
761 <td>contains a size limit for an object. (e.g. One may specify the
762 maximum size of the HTTP-Cache)
763 </td>
764 </tr>
765 <tr>
766 <td>SubscribedCount</td>
767 <td>long</td>
768 <td>contains the count of subscribed contents of a folder.</td>
769 </tr>
770 <tr>
771 <td>SynchronizePolicy</td>
772 <td><type>SynchronizePolicy</type></td>
773 <td>contains the policy to use when synchronizing two objects.</td>
774 </tr>
775 <tr>
776 <td>TargetFrames</td>
777 <td>string</td>
778 <td>contains information about the target frame to use when displaying
779 an object.
780 <p>The value is a string containing three tokens, separated by ";"
781 (A semicolon):<br/>
782 <dl>
783 <dt>1st token</dt>
784 <dd>Behavior on "select" ( single click )</dd>
785 <dt>2nd token</dt>
786 <dd>Behavior on "open" ( double click )</dd>
787 <dt>3rd token</dt>
788 <dd>Behavior on "open in new task" ( double click + CTRL key )</dd>
789 </dl>
790 </p>
791 <p> Each token may contain the following values:<br/>
792 <dl>
793 <dt>"_beamer"</dt>
794 <dd>Show in "Beamer"</dd>
795 <dt>"_top"</dt>
796 <dd>Show in current frame (replaces old)</dd>
797 <dt>"_blank"</dt>
798 <dd>Show in new task</dd>
799 </dl>
800 </p>
801 </td>
802 </tr>
803 <tr>
804 <td>TargetURL</td>
805 <td>string</td>
806 <td>for contents that are links to other contents, contains the URL of
807 the target content</td>
808 </tr>
809 <tr>
810 <td>TimeLimitStore</td>
811 <td>short</td>
812 <td>contains the value to use if the property "IsTimeLimitedStore" is set.</td>
813 </tr>
814 <tr>
815 <td>UserName</td>
816 <td>string</td>
817 <td>contains a user name. (e.g. the user name needed to access a
818 POP3-Account)</td>
819 </tr>
820 <tr>
821 <td>VerificationMode</td>
822 <td><type>VerificationMode</type> </td>
823 <td>describes a verification policy.</td>
824 </tr>
825 </tbody>
826 </table>
|
605 */
606 interface com::sun::star::ucb::XCommandProcessor;
607
| 827 */
828 interface com::sun::star::ucb::XCommandProcessor;
829
|
608 //-------------------------------------------------------------------------
| 830
|
609 /** is an enhanced version of <type>XCommandProcessor</type> that has an
610 additional method for releasing command identifiers obtained via
611 <member>XCommandProcessor::createCommandIdentifier</member> to avoid
612 resource leaks. For a detailed description of the problem refer to
613 <member>XCommandProcessor2::releaseCommandIdentifier</member>.
614
615 <p>Where many existing <type>Content</type> implementations do not
616 (yet), every new implementation should support this interface.
617 */
618 [optional] interface com::sun::star::ucb::XCommandProcessor2;
619
| 831 /** is an enhanced version of <type>XCommandProcessor</type> that has an
832 additional method for releasing command identifiers obtained via
833 <member>XCommandProcessor::createCommandIdentifier</member> to avoid
834 resource leaks. For a detailed description of the problem refer to
835 <member>XCommandProcessor2::releaseCommandIdentifier</member>.
836
837 <p>Where many existing <type>Content</type> implementations do not
838 (yet), every new implementation should support this interface.
839 */
840 [optional] interface com::sun::star::ucb::XCommandProcessor2;
841
|
620 //-------------------------------------------------------------------------
| 842
|
621 /** notifies changes of property values to listeners registered for
622 those properties.
623
624 <p>This interface is required.
625 */
626 interface com::sun::star::beans::XPropertiesChangeNotifier;
627
| 843 /** notifies changes of property values to listeners registered for
844 those properties.
845
846 <p>This interface is required.
847 */
848 interface com::sun::star::beans::XPropertiesChangeNotifier;
849
|
628 //-------------------------------------------------------------------------
| 850
|
629 /** can be used to add new properties to the content and to remove
630 properties from the content dynamically.
631
632 <p>Note that the dynamic properties must be kept persistent. The
633 service <type>Store</type> (UCB persistence service) may be used to
634 implement this.
635
636 <p><b>Important:</b> The implementation of
637 <method scope="com::sun::star::beans">XPropertyContainer::addProperty</method>
638 must at least support adding properties of the following basic data
639 types:
640
641 <p>
| 851 /** can be used to add new properties to the content and to remove
852 properties from the content dynamically.
853
854 <p>Note that the dynamic properties must be kept persistent. The
855 service <type>Store</type> (UCB persistence service) may be used to
856 implement this.
857
858 <p><b>Important:</b> The implementation of
859 <method scope="com::sun::star::beans">XPropertyContainer::addProperty</method>
860 must at least support adding properties of the following basic data
861 types:
862
863 <p>
|
642 <ul>
643 <li>boolean
644 <li>char
645 <li>byte
646 <li>string
647 <li>short
648 <li>long
649 <li>hyper
650 <li>float
651 <li>double
652 </ul>
| 864 <ul>
865 <li>boolean
866 <li>char
867 <li>byte
868 <li>string
869 <li>short
870 <li>long
871 <li>hyper
872 <li>float
873 <li>double
874 </ul>
875 </p>
|
653
654 <p>If a property with an unsupported type shall be added a
655 <type scope="com::sun::star::beans">IllegalTypeException</type> must
656 be raised.
| 876
877 <p>If a property with an unsupported type shall be added a
878 <type scope="com::sun::star::beans">IllegalTypeException</type> must
879 be raised.
|
| 880
881 @deprecated
882 <p>This interface is <b>deprecated</b>, because a
883 <type>ContentProvider</type> might need a
884 <type>XCommandEnvironment</type> to perform the tasks of adding and
885 removing properties. New implementations should implement the
886 respective commands "addProperty" and "removeProperty" instead.
|
657 */
658 interface com::sun::star::beans::XPropertyContainer;
659
| 887 */
888 interface com::sun::star::beans::XPropertyContainer;
889
|
660 //-------------------------------------------------------------------------
| 890
|
661 /** can be used to notify properties removed from or added to the
662 content's property set.
663
664 <p>This interface must be implemented, if the implementation can
665 dynamically change it's property set ( e.g. because it implements
666 the interface
667 <type scope="com::sun::star::beans">XPropertyContainer</type>. )
668 */
669 [optional] interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
670
| 891 /** can be used to notify properties removed from or added to the
892 content's property set.
893
894 <p>This interface must be implemented, if the implementation can
895 dynamically change it's property set ( e.g. because it implements
896 the interface
897 <type scope="com::sun::star::beans">XPropertyContainer</type>. )
898 */
899 [optional] interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
900
|
671 //-------------------------------------------------------------------------
| 901
|
672 /** can be used to notify commands removed from or added to the
673 content's command set.
674
675 <p>This interface must be implemented, if the implementation can
676 dynamically change it's command set ( e.g. because the set of
677 available commands depends on the value of a property of the
678 content ).
679
680 <p>This interface is optional.
681 */
682 [optional] interface com::sun::star::ucb::XCommandInfoChangeNotifier;
683
| 902 /** can be used to notify commands removed from or added to the
903 content's command set.
904
905 <p>This interface must be implemented, if the implementation can
906 dynamically change it's command set ( e.g. because the set of
907 available commands depends on the value of a property of the
908 content ).
909
910 <p>This interface is optional.
911 */
912 [optional] interface com::sun::star::ucb::XCommandInfoChangeNotifier;
913
|
684 //-------------------------------------------------------------------------
| 914
|
685 /** creates new contents (i.e. creates a new folder in another folder
686 somewhere in the local file system).
687
688 <p>A content is "new", if it does not physically exist before creating
689 it using this interface.
690
691 <p>This interface is optional. It should be implemented by contents
692 which shall be able to create new objects.
693
694 @deprecated
695
696 <p>This interface is <b>deprecated</b>. Use property
697 "CreatableContentsInfo" and command "createNewContent" instead.
698 */
699 [optional] interface com::sun::star::ucb::XContentCreator;
700
| 915 /** creates new contents (i.e. creates a new folder in another folder
916 somewhere in the local file system).
917
918 <p>A content is "new", if it does not physically exist before creating
919 it using this interface.
920
921 <p>This interface is optional. It should be implemented by contents
922 which shall be able to create new objects.
923
924 @deprecated
925
926 <p>This interface is <b>deprecated</b>. Use property
927 "CreatableContentsInfo" and command "createNewContent" instead.
928 */
929 [optional] interface com::sun::star::ucb::XContentCreator;
930
|
701 //-------------------------------------------------------------------------
| 931
|
702 /** provides access to the parent content of this content.
703
704 <p>The object returned by the implementation of the method
705 <member scope="com::sun::star::container">XChild::getParent()</member>
706 must implement the service <type>Content</type>. If the content is a
707 root object, an empty interface may be returned.
708
709 <p>This interface must be implemented by a content which is a (logical)
710 child of a content.
711 */
712 [optional] interface com::sun::star::container::XChild;
713};
714
| 932 /** provides access to the parent content of this content.
933
934 <p>The object returned by the implementation of the method
935 <member scope="com::sun::star::container">XChild::getParent()</member>
936 must implement the service <type>Content</type>. If the content is a
937 root object, an empty interface may be returned.
938
939 <p>This interface must be implemented by a content which is a (logical)
940 child of a content.
941 */
942 [optional] interface com::sun::star::container::XChild;
943};
944
|
715//=============================================================================
716
| |
717}; }; }; };
718
719#endif
| 945}; }; }; };
946
947#endif
|
720
| |
| |