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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module ucb {
  22
  23 /** contains data of several rows of a ContentResultSet.
  24
  25     <p>This struct is returned from XFetchProvider::fetch(),
  26     for example.
  27 */
  28
  29 published struct FetchResult
  30 {
  31     /** contains the demanded data.
  32
  33         <p>One any contains the data of one whole row. Those methods which
  34         use this struct have to specify, what the any has to contain.
  35     */
  36     sequence< any > Rows;
  37
  38     /** indicates the index of the first row contained in
  39         FetchResult::Rows in the original result set. So if
  40         FetchResult::StartIndex equals <code>3</code>, the
  41         first element in the sequence FetchResult::Rows
  42         contains the data of the index <code>3</code> in the original result set.
  43
  44         <p>The following rows are one after the other, but the direction
  45         depends on the value of FetchResult::Direction
  46     */
  47     long StartIndex;
  48
  49     /** indicates the orientation in which the rows are fetched and set into
  50         the sequence FetchResult::Rows.
  51
  52         <p>When FetchResult::Orientation equals `TRUE`, the
  53         rows in FetchResult::Rows are ordered in the same way
  54         as in the original result set.
  55     */
  56     boolean Orientation;
  57
  58     /** indicates whether and which error has occurred, while fetching.
  59
  60         <p>The value may contain zero or more constants of the
  61         FetchError constants group.
  62     */
  63     short FetchError;
  64 };
  65
  66
  67 }; }; }; };
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */