1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_ucb_FetchResult_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_ucb_FetchResult_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir//============================================================================= 31*cdf0e10cSrcweir 32*cdf0e10cSrcweirmodule com { module sun { module star { module ucb { 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir//============================================================================= 35*cdf0e10cSrcweir/** contains data of several rows of a <type>ContentResultSet</type>. 36*cdf0e10cSrcweir 37*cdf0e10cSrcweir <p>This struct is returned from <member>XFetchProvider::fetch</member>, 38*cdf0e10cSrcweir for example. 39*cdf0e10cSrcweir*/ 40*cdf0e10cSrcweir 41*cdf0e10cSrcweirpublished struct FetchResult 42*cdf0e10cSrcweir{ 43*cdf0e10cSrcweir //------------------------------------------------------------------------- 44*cdf0e10cSrcweir /** contains the demanded data. 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir <p>One any contains the data of one whole row. Those methods which 47*cdf0e10cSrcweir use this struct have to specify, what the any has to contain. 48*cdf0e10cSrcweir */ 49*cdf0e10cSrcweir sequence< any > Rows; 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir //------------------------------------------------------------------------- 52*cdf0e10cSrcweir /** indicates the index of the first row contained in 53*cdf0e10cSrcweir <member>FetchResult::Rows</member> in the original resultset. So if 54*cdf0e10cSrcweir <member>FetchResult::StartIndex</member> equals <code>3</code>, the 55*cdf0e10cSrcweir first element in the sequence <member>FetchResult::Rows</member> 56*cdf0e10cSrcweir contains the data of the index <code>3</code> in the original resultset. 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir <p>The following rows are one after the other, but the direction 59*cdf0e10cSrcweir depends on the value of <member>FetchResult::Direction</member> 60*cdf0e10cSrcweir */ 61*cdf0e10cSrcweir long StartIndex; 62*cdf0e10cSrcweir 63*cdf0e10cSrcweir //------------------------------------------------------------------------- 64*cdf0e10cSrcweir /** indicates the orientation in which the rows are fetched and set into 65*cdf0e10cSrcweir the sequence <member>FetchResult::Rows</member>. 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir <p>When <member>FetchResult::Orientation</member> equals <TRUE/>, the 68*cdf0e10cSrcweir rows in <member>FetchResult::Rows</member> are ordered in the same way 69*cdf0e10cSrcweir as in the original resultset. 70*cdf0e10cSrcweir */ 71*cdf0e10cSrcweir boolean Orientation; 72*cdf0e10cSrcweir 73*cdf0e10cSrcweir //------------------------------------------------------------------------- 74*cdf0e10cSrcweir /** indicates whether and which error has occured, while fetching. 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir <p>The value may contain zero or more constants of the 77*cdf0e10cSrcweir <type>FetchError</type> constants group. 78*cdf0e10cSrcweir */ 79*cdf0e10cSrcweir short FetchError; 80*cdf0e10cSrcweir}; 81*cdf0e10cSrcweir 82*cdf0e10cSrcweir//============================================================================= 83*cdf0e10cSrcweir 84*cdf0e10cSrcweir}; }; }; }; 85*cdf0e10cSrcweir 86*cdf0e10cSrcweir#endif 87