Version 5.2.6.1, tag libreoffice-5.2.6.1
[LibreOffice.git] / offapi / com / sun / star / ucb / FetchResult.idl
blobc4aee33a02f99d3c5f83caef4725ff255fb336ce
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
19 #ifndef __com_sun_star_ucb_FetchResult_idl__
20 #define __com_sun_star_ucb_FetchResult_idl__
23 module com { module sun { module star { module ucb {
25 /** contains data of several rows of a ContentResultSet.
27 <p>This struct is returned from XFetchProvider::fetch(),
28 for example.
31 published struct FetchResult
33 /** contains the demanded data.
35 <p>One any contains the data of one whole row. Those methods which
36 use this struct have to specify, what the any has to contain.
38 sequence< any > Rows;
40 /** indicates the index of the first row contained in
41 FetchResult::Rows in the original result set. So if
42 FetchResult::StartIndex equals <code>3</code>, the
43 first element in the sequence FetchResult::Rows
44 contains the data of the index <code>3</code> in the original result set.
46 <p>The following rows are one after the other, but the direction
47 depends on the value of FetchResult::Direction
49 long StartIndex;
51 /** indicates the orientation in which the rows are fetched and set into
52 the sequence FetchResult::Rows.
54 <p>When FetchResult::Orientation equals `TRUE`, the
55 rows in FetchResult::Rows are ordered in the same way
56 as in the original result set.
58 boolean Orientation;
60 /** indicates whether and which error has occurred, while fetching.
62 <p>The value may contain zero or more constants of the
63 FetchError constants group.
65 short FetchError;
69 }; }; }; };
71 #endif
73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */