/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: FTPContent.idl,v $
* $Revision: 1.9 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
*
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_ucb_FTPContent_idl__
#define __com_sun_star_ucb_FTPContent_idl__
#ifndef __com_sun_star_lang_XComponent_idl__
#include
#endif
#ifndef __com_sun_star_ucb_XContent_idl__
#include
#endif
#ifndef __com_sun_star_ucb_XContentCreator_idl__
#include
#endif
#ifndef __com_sun_star_ucb_XCommandProcessor_idl__
#include
#endif
#ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__
#include
#endif
#ifndef __com_sun_star_beans_XPropertyContainer_idl__
#include
#endif
#ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__
#include
#endif
#ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__
#include
#endif
#ifndef __com_sun_star_container_XChild_idl__
#include
#endif
//=============================================================================
module com { module sun { module star { module ucb {
//=============================================================================
/** A FTPContent provides an object representing either a (ftp-server-side)
directory object allowing listing of children or a content object providing
access to a (ftp-server-side) file.
@see com::sun::star::ucb::FTPContentProvider
@since OOo 1.1.2
*/
published service FTPContent
{
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::lang::XComponent;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::ucb::XContent;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
An object representing a directory in the file system is able
to create a new object, which in turn can become the representation
of a physical file/directory being contained in the initial directory.
The precise way is the following:
-
Let the parent folder create a new content by calling
XContentCreator::createNewContent on it. The content
type to use for new directories is
"application/vnd.sun.staroffice.ftp-folder". To create a new file
use the type "application/vnd.sun.staroffice.ftp-file".
As return value you get a new file content object.
-
Set a title at the new object by letting it execute
the command "setPropertyValues", which sets at least the property
"Title" to a non-empty value ).
-
Let the new object ( not the parent! ) execute the command "insert".
This will create the corresponding physical file or directory.
For files, you need to supply the implementation of
an XInputStream with the
command's parameters, that provides access to the stream data.
*/
interface com::sun::star::ucb::XContentCreator;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
Supported Commands
-
getCommandInfo
-
getPropertySetInfo
-
getPropertyValues
-
setPropertyValues
-
open
-
insert
-
delete
Supported Properties
-
string ContentType ( read-only, either
"application/vnd.sun.staroffice.ftp-folder" or
"application/vnd.sun.staroffice.ftp-file" )
-
boolean IsDocument ( read-only, always for files, always
for directories )
-
boolean IsFolder ( read-only ), always for files, always
for directories )
-
boolean IsReadOnly ( read-only attribute )
-
string Title ( file name )
-
hyper Size ( file size )
-
string Title ( file name )
-
DateTimeDateCreated ( read-only )
*/
interface com::sun::star::ucb::XCommandProcessor;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::beans::XPropertiesChangeNotifier;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::beans::XPropertyContainer;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::ucb::XCommandInfoChangeNotifier;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::container::XChild;
};
//=============================================================================
}; }; }; };
#endif