1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_ucb_OpenCommandArgument_idl__
28#define __com_sun_star_ucb_OpenCommandArgument_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_beans_Property_idl__
35#include <com/sun/star/beans/Property.idl>
36#endif
37
38//=============================================================================
39
40module com { module sun { module star { module ucb {
41
42//=============================================================================
43/** The argument for commands like "open", "update", and "synchronize".
44
45	@see XCommandProcessor
46*/
47published struct OpenCommandArgument
48{
49	//-------------------------------------------------------------------------
50	/** A mode.
51
52	    <p>The value can be one of the <type>OpenMode</type> constants.
53	*/
54	long Mode;
55
56	//-------------------------------------------------------------------------
57	/** The command's priority, in the range <code>0</code> (highest) to
58	    <code>65535</code> (lowest).
59	*/
60	long Priority;
61
62	//-------------------------------------------------------------------------
63	/** The data sink to write the contents into (supporting either
64		<type scope="com::sun::star::io">XActiveDataSink</type>,
65		<type scope="com::sun::star::io">XOutputStream</type> or
66		<type scope="com::sun::star::io">XActiveDataStreamer</type>).
67
68		<p>XActiveDataSink and XOutputStream give the caller read-only
69		access to the contents.	XActiveDataStreamer offers both read and
70		write access to the contents.
71
72		<p>If an XActiveDataSink is supplied, the implementation of the command
73		needs to provide an implementation of an object implementing the
74		interface <type scope="com::sun::star::io">XInputStream</type>. It is
75		highly recommended that this object also implements the interface
76		<type scope="com::sun::star::io">XSeekable</type>, if this can be done
77		without wasting resources (i.e. allocating huge memory buffers).
78		The	implementation object has to be supplied to the data sink.
79	*/
80	com::sun::star::uno::XInterface Sink;
81
82	//-------------------------------------------------------------------------
83	/** The properties, for that the values shall be provided by the
84        <type>DynamicResultSet</type> returned by the command).
85	*/
86	sequence< com::sun::star::beans::Property > Properties;
87};
88
89//=============================================================================
90
91}; }; }; };
92
93#endif
94