/*************************************************************************
 *
 *  $RCSfile: FetchResult.idl,v $
 *
 *  $Revision: 1.1 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 09:22:31 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_FetchResult_idl__
#define __com_sun_star_ucb_FetchResult_idl__

//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** containes data of several rows.
This struct is returned e.g. from <method>XFetchProvider::fetch</method>.
*/

struct FetchResult
{
    //-------------------------------------------------------------------------
    /** containes the demanded data.

        <p>One <atom>any</atom> contains the data of one whole row.
        Those methods which use this struct have to specify,
        what the any has to contain.
    */
    sequence< any > Rows;

    //-------------------------------------------------------------------------
    /** indicates the index of the first in <member>Rows</member> contained
    row in the original result set. So if <member>StartIndex</member> equals 3,
    the first element in the sequence <member>Rows</member> containes the data
    of the index 3 in the original result set.

    <p>The following rows are one after the other, but the direction depends on
    <member>Direction</member>
    */
    long StartIndex;

    //-------------------------------------------------------------------------
    /** indicates the orientation in which the rows are fetched and set into
    the sequence <member>Rows</member>.

    <p>When <member>Orientation</member> equals TRUE, rows in
    <member>Rows</member> are ordered in the same way as in the original result
    set.
    */
    boolean Orientation;

    //-------------------------------------------------------------------------
    /** indicates whether and which error has occured, while    fetching.

        <p>The value may contain zero or more constants of the
        <type>FetchError</type> constants group.
    */
    short FetchError;
};

//=============================================================================

}; }; }; };

#endif