1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ucb_FetchResult_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_ucb_FetchResult_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski//============================================================================= 27*b1cdbd2cSJim Jagielski 28*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module ucb { 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski//============================================================================= 31*b1cdbd2cSJim Jagielski/** contains data of several rows of a <type>ContentResultSet</type>. 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski <p>This struct is returned from <member>XFetchProvider::fetch</member>, 34*b1cdbd2cSJim Jagielski for example. 35*b1cdbd2cSJim Jagielski*/ 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielskipublished struct FetchResult 38*b1cdbd2cSJim Jagielski{ 39*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 40*b1cdbd2cSJim Jagielski /** contains the demanded data. 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski <p>One any contains the data of one whole row. Those methods which 43*b1cdbd2cSJim Jagielski use this struct have to specify, what the any has to contain. 44*b1cdbd2cSJim Jagielski */ 45*b1cdbd2cSJim Jagielski sequence< any > Rows; 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 48*b1cdbd2cSJim Jagielski /** indicates the index of the first row contained in 49*b1cdbd2cSJim Jagielski <member>FetchResult::Rows</member> in the original resultset. So if 50*b1cdbd2cSJim Jagielski <member>FetchResult::StartIndex</member> equals <code>3</code>, the 51*b1cdbd2cSJim Jagielski first element in the sequence <member>FetchResult::Rows</member> 52*b1cdbd2cSJim Jagielski contains the data of the index <code>3</code> in the original resultset. 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski <p>The following rows are one after the other, but the direction 55*b1cdbd2cSJim Jagielski depends on the value of <member>FetchResult::Direction</member> 56*b1cdbd2cSJim Jagielski */ 57*b1cdbd2cSJim Jagielski long StartIndex; 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 60*b1cdbd2cSJim Jagielski /** indicates the orientation in which the rows are fetched and set into 61*b1cdbd2cSJim Jagielski the sequence <member>FetchResult::Rows</member>. 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski <p>When <member>FetchResult::Orientation</member> equals <TRUE/>, the 64*b1cdbd2cSJim Jagielski rows in <member>FetchResult::Rows</member> are ordered in the same way 65*b1cdbd2cSJim Jagielski as in the original resultset. 66*b1cdbd2cSJim Jagielski */ 67*b1cdbd2cSJim Jagielski boolean Orientation; 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 70*b1cdbd2cSJim Jagielski /** indicates whether and which error has occured, while fetching. 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski <p>The value may contain zero or more constants of the 73*b1cdbd2cSJim Jagielski <type>FetchError</type> constants group. 74*b1cdbd2cSJim Jagielski */ 75*b1cdbd2cSJim Jagielski short FetchError; 76*b1cdbd2cSJim Jagielski}; 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski//============================================================================= 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski}; }; }; }; 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski#endif 83