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_XContentCreator_idl__
24#define __com_sun_star_ucb_XContentCreator_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_ucb_ContentInfo_idl__
31#include <com/sun/star/ucb/ContentInfo.idl>
32#endif
33
34#ifndef __com_sun_star_ucb_XContent_idl__
35#include <com/sun/star/ucb/XContent.idl>
36#endif
37
38
39//=============================================================================
40
41module com { module sun { module star { module ucb {
42
43//=============================================================================
44/** A creator for new (persistent) contents, like file system folders.
45
46    <p>Creation of a new (persistent) content:
47    <ol>
48        <li>creatabletypes = creator.queryCreatableContentsInfo()
49        <li>choose a suitable type from creatabletypes
50        <li>newObject = creator.createNewContent( type )
51        <li>initialize the new object (i.e. newObject.Property1 = ...)
52        <li>let the new content execute the command "insert". That command
53            commits the data and makes the new content persistent.
54    </ol>
55
56    @deprecated
57
58    <p>This interface is deprecated.  Use <type>Content</type> property
59       "CreatableContentsInfo" and command "createNewContent" instead.
60
61    @version  1.0
62    @author   Kai Sommerfeld
63    @see      XContent
64    @see      XCommandProcessor
65*/
66published interface XContentCreator: com::sun::star::uno::XInterface
67{
68    //-------------------------------------------------------------------------
69    /** returns a list with information about the creatable contents.
70
71        @returns
72        the list with information about the creatable contents.
73    */
74    sequence<com::sun::star::ucb::ContentInfo> queryCreatableContentsInfo();
75
76    //-------------------------------------------------------------------------
77    /** creates a new content of given type.
78
79        @param Info
80        the content information.
81
82        @returns
83        the new content, if operation was successful.
84    */
85    com::sun::star::ucb::XContent createNewContent(
86                        [in] com::sun::star::ucb::ContentInfo Info );
87};
88
89//=============================================================================
90
91}; }; }; };
92
93#endif
94