offapi/com/sun/star/ucb/FetchResult.idl

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