offapi/com/sun/star/ucb/ODMAContent.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: ODMAContent.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_ODMAContent_idl__
  31 #define __com_sun_star_ucb_ODMAContent_idl__
  32
  33 #ifndef __com_sun_star_lang_XComponent_idl__
  34 #include <com/sun/star/lang/XComponent.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ucb_XContent_idl__
  38 #include <com/sun/star/ucb/XContent.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_ucb_XCommandProcessor_idl__
  42 #include <com/sun/star/ucb/XCommandProcessor.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_ucb_XCommandProcessor2_idl__
  46 #include <com/sun/star/ucb/XCommandProcessor2.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__
  50 #include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_beans_XPropertyContainer_idl__
  54 #include <com/sun/star/beans/XPropertyContainer.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__
  58 #include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__
  62 #include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_container_XChild_idl__
  66 #include <com/sun/star/container/XChild.idl>
  67 #endif
  68
  69 //=============================================================================
  70
  71 module com { module sun { module star { module ucb {
  72
  73 //=============================================================================
  74 /** A OCP content is representation of a document saved in a DMS.
  75
  76     <p>The document Content corresponds to a document stored in a Document Management System.
  77     </p>
  78
  79     @see com::sun::star::ucb::ODMAContentProvider
  80     @see com::sun::star::ucb::Content
  81
  82     @since OOo 1.1.2
  83 */
  84 published service ODMAContent
  85 {
  86     //-------------------------------------------------------------------------
  87     /** This interface is implemented according to the specification of
  88         service <type>Content</type>.
  89      */
  90     interface com::sun::star::lang::XComponent;
  91
  92     //-------------------------------------------------------------------------
  93     /** This interface is implemented according to the specification of
  94         service <type>Content</type>.
  95      */
  96     interface com::sun::star::ucb::XContent;
  97
  98     //-------------------------------------------------------------------------
  99     /** This interface is implemented according to the specification of
 100         service <type>Content</type>.
 101
 102         <p>
 103
 104         <b>Supported Commands</b>
 105         <ul>
 106         <li>
 107         getCommandInfo
 108         </li>
 109         <li>
 110         getPropertySetInfo
 111         </li>
 112         <li>
 113         getPropertyValues
 114         </li>
 115         <li>
 116         setPropertyValues
 117         </li>
 118         <li>
 119         delete
 120         </li>
 121         <li>
 122         open
 123         </li>
 124         <li>
 125         close
 126         </li>
 127         </ul>
 128
 129         <b>Supported Properties</b>
 130         <ul>
 131         <li>
 132         string ContentType ( read-only, always "application/vnd.sun.star.odma" )
 133         </li>
 134         <li>
 135         boolean IsDocument
 136         </li>
 137         <li>
 138         boolean IsFolder
 139         </li>
 140         <li>
 141         <type scope="com::sun::star::util">DateTime</type> DateCreated ( read-only )
 142         </li>
 143         <li>
 144         <type scope="com::sun::star::util">DateTime</type> DateModified ( read-only )
 145         </li>
 146         <li>
 147         string Author
 148         </li>
 149         <li>
 150         string Subject
 151         </li>
 152         <li>
 153         string Keywords
 154         </li>
 155         <li>
 156         string Size ( read-only )
 157         </li>
 158         <li>
 159         string Title
 160         </li>
 161         </ul>
 162
 163         </p>
 164      */
 165     interface com::sun::star::ucb::XCommandProcessor;
 166
 167     //-------------------------------------------------------------------------
 168     /** is an enhanced version of <type>XCommandProcessor</type> that has an
 169         additional method for releasing command identifiers obtained via
 170         <member>XCommandProcessor::createCommandIdentifier</member> to avoid
 171         resource leaks. For a detailed description of the problem refer to
 172         <member>XCommandProcessor2::releaseCommandIdentifier</member>.
 173
 174         <p>Where many existing <type>Content</type> implementations do not
 175         (yet), every new implementation should support this interface.
 176      */
 177     [optional] interface com::sun::star::ucb::XCommandProcessor2;
 178
 179     //-------------------------------------------------------------------------
 180     /** This interface is implemented according to the specification of
 181         service <type>Content</type>.
 182      */
 183     interface com::sun::star::beans::XPropertiesChangeNotifier;
 184
 185     //-------------------------------------------------------------------------
 186     /** This interface is implemented according to the specification of
 187         service <type>Content</type>.
 188      */
 189     interface com::sun::star::beans::XPropertyContainer;
 190
 191     //-------------------------------------------------------------------------
 192     /** This interface is implemented according to the specification of
 193         service <type>Content</type>.
 194      */
 195     interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
 196
 197     //-------------------------------------------------------------------------
 198     /** This interface is implemented according to the specification of
 199         service <type>Content</type>.
 200      */
 201     interface com::sun::star::ucb::XCommandInfoChangeNotifier;
 202
 203     //-------------------------------------------------------------------------
 204     /** This interface is implemented according to the specification of
 205         service <type>Content</type>.
 206      */
 207     interface com::sun::star::container::XChild;
 208 };
 209
 210 //=============================================================================
 211
 212 }; }; }; };
 213
 214 #endif