/*************************************************************************
*
* $RCSfile: PackageFolderContent.idl,v $
*
* $Revision: 1.7 $
*
* last change: $Author: mi $ $Date: 2002-10-03 13:10:24 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_ucb_PackageFolderContent_idl__
#define __com_sun_star_ucb_PackageFolderContent_idl__
#ifndef __com_sun_star_lang_XComponent_idl__
#include
#endif
#ifndef __com_sun_star_ucb_XContent_idl__
#include
#endif
#ifndef __com_sun_star_ucb_XCommandProcessor_idl__
#include
#endif
#ifndef __com_sun_star_ucb_XCommandProcessor2_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
#ifndef __com_sun_star_ucb_XContentCreator_idl__
#include
#endif
//=============================================================================
module com { module sun { module star { module ucb {
//=============================================================================
/** A PCP Folder is a container for other PCP Folders and PCP Streams.
@see com::sun::star::ucb::PackageContentProvider
@see com::sun::star::ucb::PackageStreamContent
*/
service PackageFolderContent
{
//-------------------------------------------------------------------------
/** 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.
Supported Commands
-
getCommandInfo
-
getPropertySetInfo
-
getPropertyValues
-
setPropertyValues
-
insert ( makes a newly created folder persistent )
-
delete
-
open
-
transfer ( only transfers from PCP Folders/PCP Streams to other
PCP folders. It does not handle contents with a URL scheme other
then the PCP-URL-scheme. )
-
flush ( a command introduced by the PCP Folder. It takes a
void-argument and returns void. This command is used to write unsaved
changes to the underlying package file. Note that the current
implementation of PCP contents never flushes automatically! Operations
which require a flush to get persistent, are:
"setPropertyValues( < any_non_read_only_property > ) ", "delete",
"insert" )
Supported Properties
-
string ContentType ( read-only, always "application/vnd.sun.star.pkg-folder" )
-
boolean IsDocument ( read-only, always false )
-
boolean IsFolder ( read-only, always true )
-
string MediaType
-
string Title
*/
interface com::sun::star::ucb::XCommandProcessor;
//-------------------------------------------------------------------------
/** is an enhanced version of XCommandProcessor that has an
additional method for releasing command identifiers obtained via
XCommandProcessor::createCommandIdentifier to avoid
resource leaks. For a detailed description of the problem refer to
XCommandProcessor2::releaseCommandIdentifier.
Where many existing Content 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 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;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
A PCP Folder can create other PCP Folders and PCP Streams. To create
a new child of a PCP Folder:
-
Let the parent folder create a new content by calling
XContentCreator::createNewContent on it. The content
type to use for new folders is "application/vnd.sun.star.pkg-folder".
To create a new PCP Stream, use the type
"application/vnd.sun.star.pkg-stream".
-
Set a title at the new folder / stream. ( Let the new child execute
the command "setPropertyValues", which sets at least the property
"Title" to a non-empty value ).
-
Let the new child ( not the parent! ) execute the command "insert".
This will commit the creation process. For streams, you need to supply
the implementation of an
XInputStream with the command's
parameters, that provides access to the stream data.
Another, more convenient way for creating streams is simply to assemble
the URL for the new content ( last part of the path will become the
title of the new stream ) and to obtain a Content object for that URL
from the UCB. Then let the content execute the command "insert". The
command will fail, if you set the command's parameter
InsertCommandArgument::ReplaceExisting"
to false and there is already a stream with the title given by the
content's URL.
*/
interface com::sun::star::ucb::XContentCreator;
};
//=============================================================================
}; }; }; };
#endif