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