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

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