1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_ucb_OpenCommandArgument_idl__ 24#define __com_sun_star_ucb_OpenCommandArgument_idl__ 25 26#ifndef __com_sun_star_uno_XInterface_idl__ 27#include <com/sun/star/uno/XInterface.idl> 28#endif 29 30#ifndef __com_sun_star_beans_Property_idl__ 31#include <com/sun/star/beans/Property.idl> 32#endif 33 34//============================================================================= 35 36module com { module sun { module star { module ucb { 37 38//============================================================================= 39/** The argument for commands like "open", "update", and "synchronize". 40 41 @see XCommandProcessor 42*/ 43published struct OpenCommandArgument 44{ 45 //------------------------------------------------------------------------- 46 /** A mode. 47 48 <p>The value can be one of the <type>OpenMode</type> constants. 49 */ 50 long Mode; 51 52 //------------------------------------------------------------------------- 53 /** The command's priority, in the range <code>0</code> (highest) to 54 <code>65535</code> (lowest). 55 */ 56 long Priority; 57 58 //------------------------------------------------------------------------- 59 /** The data sink to write the contents into (supporting either 60 <type scope="com::sun::star::io">XActiveDataSink</type>, 61 <type scope="com::sun::star::io">XOutputStream</type> or 62 <type scope="com::sun::star::io">XActiveDataStreamer</type>). 63 64 <p>XActiveDataSink and XOutputStream give the caller read-only 65 access to the contents. XActiveDataStreamer offers both read and 66 write access to the contents. 67 68 <p>If an XActiveDataSink is supplied, the implementation of the command 69 needs to provide an implementation of an object implementing the 70 interface <type scope="com::sun::star::io">XInputStream</type>. It is 71 highly recommended that this object also implements the interface 72 <type scope="com::sun::star::io">XSeekable</type>, if this can be done 73 without wasting resources (i.e. allocating huge memory buffers). 74 The implementation object has to be supplied to the data sink. 75 */ 76 com::sun::star::uno::XInterface Sink; 77 78 //------------------------------------------------------------------------- 79 /** The properties, for that the values shall be provided by the 80 <type>DynamicResultSet</type> returned by the command). 81 */ 82 sequence< com::sun::star::beans::Property > Properties; 83}; 84 85//============================================================================= 86 87}; }; }; }; 88 89#endif 90