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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_FTPContent_idl__
  20 #define __com_sun_star_ucb_FTPContent_idl__
  21
  22 #include <com/sun/star/lang/XComponent.idl>
  23 #include <com/sun/star/ucb/XContent.idl>
  24 #include <com/sun/star/ucb/XContentCreator.idl>
  25 #include <com/sun/star/ucb/XCommandProcessor.idl>
  26 #include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
  27 #include <com/sun/star/beans/XPropertyContainer.idl>
  28 #include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
  29 #include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
  30 #include <com/sun/star/container/XChild.idl>
  31
  32
  33 module com { module sun { module star { module ucb {
  34
  35 /** A FTPContent provides an object representing either a (ftp-server-side)
  36     directory object allowing listing of children or a content object providing
  37     access to a (ftp-server-side) file.
  38
  39     @see com::sun::star::ucb::FTPContentProvider
  40
  41     @since OOo 1.1.2
  42 */
  43 published service FTPContent
  44 {
  45     /** This interface is implemented according to the specification of
  46         service Content.
  47      */
  48     interface com::sun::star::lang::XComponent;
  49
  50     /** This interface is implemented according to the specification of
  51         service Content.
  52      */
  53     interface com::sun::star::ucb::XContent;
  54
  55     /** This interface is implemented according to the specification of
  56         service Content.
  57
  58         <p>An object representing a directory in the file system is able
  59         to create a new object, which in turn can become the representation
  60         of a physical file/directory being contained in the initial directory.
  61         The precise way is the following:
  62
  63         <p>
  64
  65         <ol>
  66         <li>
  67         Let the parent folder create a new content by calling
  68         XContentCreator::createNewContent() on it. The content
  69         type to use for new directories is
  70         "application/vnd.sun.staroffice.ftp-folder". To create a new file
  71         use the type "application/vnd.sun.staroffice.ftp-file".
  72         As return value you get a new file content object.
  73         </li>
  74         <li>
  75         Set a title at the new object by letting it execute
  76         the command "setPropertyValues", which sets at least the property
  77         "Title" to a non-empty value ).
  78         </li>
  79         <li>
  80         Let the new object ( not the parent! ) execute the command "insert".
  81         This will create the corresponding physical file or directory.
  82         For files, you need to supply the implementation of
  83         an com::sun::star::io::XInputStream with the
  84         command's parameters, that provides access to the stream data.
  85         </li>
  86         </ol>
  87
  88         </p>
  89      */
  90     interface com::sun::star::ucb::XContentCreator;
  91
  92     /** This interface is implemented according to the specification of
  93         service Content.
  94
  95         <p>
  96
  97         <b>Supported Commands</b>
  98
  99         <ul>
 100         <li>
 101         getCommandInfo
 102         </li>
 103         <li>
 104         getPropertySetInfo
 105         </li>
 106         <li>
 107         getPropertyValues
 108         </li>
 109         <li>
 110         setPropertyValues
 111         </li>
 112         <li>
 113         open
 114         </li>
 115         <li>
 116         insert
 117         </li>
 118         <li>
 119         delete
 120         </li>
 121         </ul>
 122
 123         <b>Supported Properties</b>
 124         <ul>
 125         <li>
 126         string ContentType ( read-only, either
 127         "application/vnd.sun.staroffice.ftp-folder" or
 128         "application/vnd.sun.staroffice.ftp-file" )
 129         </li>
 130         <li>
 131         boolean IsDocument ( read-only, always `TRUE` for files, always
 132         `FALSE` for directories )
 133         </li>
 134         <li>
 135         boolean IsFolder ( read-only ), always `FALSE` for files, always
 136         `TRUE` for directories )
 137         </li>
 138         <li>
 139         boolean IsReadOnly ( read-only attribute )
 140         </li>
 141         <li>
 142         string Title ( file name )
 143         </li>
 144         <li>
 145         hyper Size ( file size )
 146         </li>
 147         <li>
 148         string Title ( file name )
 149         </li>
 150         <li>
 151         com::sun::star::util::DateTimeDateCreated ( read-only )
 152         </li>
 153         </ul>
 154         </p>
 155      */
 156     interface com::sun::star::ucb::XCommandProcessor;
 157
 158     /** This interface is implemented according to the specification of
 159         service Content.
 160      */
 161     interface com::sun::star::beans::XPropertiesChangeNotifier;
 162
 163     /** This interface is implemented according to the specification of
 164         service Content.
 165      */
 166     interface com::sun::star::beans::XPropertyContainer;
 167
 168     /** This interface is implemented according to the specification of
 169         service Content.
 170      */
 171     interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
 172
 173     /** This interface is implemented according to the specification of
 174         service Content.
 175      */
 176     interface com::sun::star::ucb::XCommandInfoChangeNotifier;
 177
 178     /** This interface is implemented according to the specification of
 179         service Content.
 180      */
 181     interface com::sun::star::container::XChild;
 182 };
 183
 184
 185 }; }; }; };
 186
 187 #endif
 188
 189 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */