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_FetchResult_idl__ 24#define __com_sun_star_ucb_FetchResult_idl__ 25 26//============================================================================= 27 28module com { module sun { module star { module ucb { 29 30//============================================================================= 31/** contains data of several rows of a <type>ContentResultSet</type>. 32 33 <p>This struct is returned from <member>XFetchProvider::fetch</member>, 34 for example. 35*/ 36 37published struct FetchResult 38{ 39 //------------------------------------------------------------------------- 40 /** contains the demanded data. 41 42 <p>One any contains the data of one whole row. Those methods which 43 use this struct have to specify, what the any has to contain. 44 */ 45 sequence< any > Rows; 46 47 //------------------------------------------------------------------------- 48 /** indicates the index of the first row contained in 49 <member>FetchResult::Rows</member> in the original resultset. So if 50 <member>FetchResult::StartIndex</member> equals <code>3</code>, the 51 first element in the sequence <member>FetchResult::Rows</member> 52 contains the data of the index <code>3</code> in the original resultset. 53 54 <p>The following rows are one after the other, but the direction 55 depends on the value of <member>FetchResult::Direction</member> 56 */ 57 long StartIndex; 58 59 //------------------------------------------------------------------------- 60 /** indicates the orientation in which the rows are fetched and set into 61 the sequence <member>FetchResult::Rows</member>. 62 63 <p>When <member>FetchResult::Orientation</member> equals <TRUE/>, the 64 rows in <member>FetchResult::Rows</member> are ordered in the same way 65 as in the original resultset. 66 */ 67 boolean Orientation; 68 69 //------------------------------------------------------------------------- 70 /** indicates whether and which error has occured, while fetching. 71 72 <p>The value may contain zero or more constants of the 73 <type>FetchError</type> constants group. 74 */ 75 short FetchError; 76}; 77 78//============================================================================= 79 80}; }; }; }; 81 82#endif 83