xref: /trunk/main/offapi/com/sun/star/ucb/OpenCommandArgument.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)

/*************************************************************************
 *
 * 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_OpenCommandArgument_idl__
#define __com_sun_star_ucb_OpenCommandArgument_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_beans_Property_idl__
#include <com/sun/star/beans/Property.idl>
#endif

//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** The argument for commands like "open", "update", and "synchronize".

    @see XCommandProcessor
*/
published struct OpenCommandArgument
{
    //-------------------------------------------------------------------------
    /** A mode.

        <p>The value can be one of the <type>OpenMode</type> constants.
    */
    long Mode;

    //-------------------------------------------------------------------------
    /** The command's priority, in the range <code>0</code> (highest) to
        <code>65535</code> (lowest).
    */
    long Priority;

    //-------------------------------------------------------------------------
    /** The data sink to write the contents into (supporting either
        <type scope="com::sun::star::io">XActiveDataSink</type>,
        <type scope="com::sun::star::io">XOutputStream</type> or
        <type scope="com::sun::star::io">XActiveDataStreamer</type>).

        <p>XActiveDataSink and XOutputStream give the caller read-only
        access to the contents. XActiveDataStreamer offers both read and
        write access to the contents.

        <p>If an XActiveDataSink is supplied, the implementation of the command
        needs to provide an implementation of an object implementing the
        interface <type scope="com::sun::star::io">XInputStream</type>. It is
        highly recommended that this object also implements the interface
        <type scope="com::sun::star::io">XSeekable</type>, if this can be done
        without wasting resources (i.e. allocating huge memory buffers).
        The implementation object has to be supplied to the data sink.
    */
    com::sun::star::uno::XInterface Sink;

    //-------------------------------------------------------------------------
    /** The properties, for that the values shall be provided by the
        <type>DynamicResultSet</type> returned by the command).
    */
    sequence< com::sun::star::beans::Property > Properties;
};

//=============================================================================

}; }; }; };

#endif