office-gobmx/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl
2011-04-02 00:08:53 +02:00

185 lines
6.6 KiB
Text

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_ucb_WebDAVDocumentContent_idl__
#define __com_sun_star_ucb_WebDAVDocumentContent_idl__
#include <com/sun/star/lang/XComponent.idl>
#include <com/sun/star/ucb/XContent.idl>
#include <com/sun/star/ucb/XCommandProcessor.idl>
#include <com/sun/star/ucb/XCommandProcessor2.idl>
#include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
#include <com/sun/star/beans/XPropertyContainer.idl>
#include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
#include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
#include <com/sun/star/container/XChild.idl>
//=============================================================================
module com { module sun { module star { module ucb {
//=============================================================================
/** A DCP Document is a container for Document data/content.
<p>The data/content may be anything, a WebDAV server, like an HTTP server,
does not necessarily mandate what type of data/content may be contained
within Documents. The type of data/content is defined by the MediaType
property which is different from the content type returned from the
<member>XContent::getContentType</member> method. The MediaType property
is mapped to the equivalent WebDAV property and the WebDAV server calculates
the value.
@see com::sun::star::ucb::WebDAVContentProvider
@see com::sun::star::ucb::WebDAVFolderContent
*/
published service WebDAVDocumentContent
{
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service <type>Content</type>.
*/
interface com::sun::star::lang::XComponent;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service <type>Content</type>.
*/
interface com::sun::star::ucb::XContent;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service <type>Content</type>.
<p>
<b>Supported Commands</b>
<ul>
<li>
getCommandInfo
</li>
<li>
getPropertySetInfo
</li>
<li>
getPropertyValues
</li>
<li>
setPropertyValues
</li>
<li>
insert ( makes a newly created document persistent )
</li>
<li>
delete
</li>
<li>
open
</li>
<li>
post ( Argument: <type>PostCommandArgument2</type> - does a HTTP POST )
</li>
</ul>
<b>Supported Properties</b>
<ul>
<li>
string ContentType ( read-only, always "application/http-content" )
</li>
<li>
boolean IsDocument ( read-only, always true )
</li>
<li>
boolean IsFolder ( read-only, always false )
</li>
<li>
<type scope="com::sun::star::util">DateTime</type> DateCreated ( read-only )
</li>
<li>
<type scope="com::sun::star::util">DateTime</type> DateModified ( read-only )
</li>
<li>
string MediaType ( read-only, the MIME type - as delivered by the server )
</li>
<li>
string Size ( read-only )
</li>
<li>
string Title
</li>
</ul>
</p>
*/
interface com::sun::star::ucb::XCommandProcessor;
//-------------------------------------------------------------------------
/** is an enhanced version of <type>XCommandProcessor</type> that has an
additional method for releasing command identifiers obtained via
<member>XCommandProcessor::createCommandIdentifier</member> to avoid
resource leaks. For a detailed description of the problem refer to
<member>XCommandProcessor2::releaseCommandIdentifier</member>.
<p>Where many existing <type>Content</type> implementations do not
(yet), every new implementation should support this interface.
*/
[optional] interface com::sun::star::ucb::XCommandProcessor2;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service <type>Content</type>.
*/
interface com::sun::star::beans::XPropertiesChangeNotifier;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service <type>Content</type>.
*/
interface com::sun::star::beans::XPropertyContainer;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service <type>Content</type>.
*/
interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service <type>Content</type>.
*/
interface com::sun::star::ucb::XCommandInfoChangeNotifier;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service <type>Content</type>.
*/
interface com::sun::star::container::XChild;
};
//=============================================================================
}; }; }; };
#endif