offapi/com/sun/star/ucb/XContentCreator.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XContentCreator.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_XContentCreator_idl__
  31 #define __com_sun_star_ucb_XContentCreator_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ucb_ContentInfo_idl__
  38 #include <com/sun/star/ucb/ContentInfo.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_ucb_XContent_idl__
  42 #include <com/sun/star/ucb/XContent.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48 module com { module sun { module star { module ucb {
  49
  50 //=============================================================================
  51 /** A creator for new (persistent) contents, like file system folders.
  52
  53     <p>Creation of a new (persistent) content:
  54     <ol>
  55         <li>newObject = creator.createNewContent( ... )
  56         <li>initialize the new object (i.e. newObject.Property1 = ...)
  57         <li>let the new content execute the command "insert". That command
  58             commits the data and makes the new content persistent.
  59     </ol>
  60
  61     @version  1.0
  62     @author   Kai Sommerfeld
  63     @see      XContent
  64     @see      XCommandProcessor
  65 */
  66 published 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 succesful.
  84     */
  85     com::sun::star::ucb::XContent createNewContent(
  86                         [in] com::sun::star::ucb::ContentInfo Info );
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 #endif