1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_ucb_XContentCreator_idl__
28#define __com_sun_star_ucb_XContentCreator_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_ucb_ContentInfo_idl__
35#include <com/sun/star/ucb/ContentInfo.idl>
36#endif
37
38#ifndef __com_sun_star_ucb_XContent_idl__
39#include <com/sun/star/ucb/XContent.idl>
40#endif
41
42
43//=============================================================================
44
45module com { module sun { module star { module ucb {
46
47//=============================================================================
48/** A creator for new (persistent) contents, like file system folders.
49
50    <p>Creation of a new (persistent) content:
51    <ol>
52        <li>creatabletypes = creator.queryCreatableContentsInfo()
53        <li>choose a suitable type from creatabletypes
54        <li>newObject = creator.createNewContent( type )
55        <li>initialize the new object (i.e. newObject.Property1 = ...)
56        <li>let the new content execute the command "insert". That command
57            commits the data and makes the new content persistent.
58    </ol>
59
60    @deprecated
61
62    <p>This interface is deprecated.  Use <type>Content</type> property
63       "CreatableContentsInfo" and command "createNewContent" instead.
64
65    @version  1.0
66    @author   Kai Sommerfeld
67    @see      XContent
68    @see      XCommandProcessor
69*/
70published interface XContentCreator: com::sun::star::uno::XInterface
71{
72    //-------------------------------------------------------------------------
73    /** returns a list with information about the creatable contents.
74
75        @returns
76        the list with information about the creatable contents.
77    */
78    sequence<com::sun::star::ucb::ContentInfo> queryCreatableContentsInfo();
79
80    //-------------------------------------------------------------------------
81    /** creates a new content of given type.
82
83        @param Info
84        the content information.
85
86        @returns
87        the new content, if operation was successful.
88    */
89    com::sun::star::ucb::XContent createNewContent(
90                        [in] com::sun::star::ucb::ContentInfo Info );
91};
92
93//=============================================================================
94
95}; }; }; };
96
97#endif
98