Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Elements' Summary Elements' Details

:: com :: sun :: star :: ucb ::

struct FetchResult
Description
contains data of several rows of a ContentResultSet.

This struct is returned from XFetchProvider::fetch, for example.

Elements' Summary
Rows contains the demanded data.  
StartIndex indicates the index of the first row contained in FetchResult::Rows in the original resultset. So if FetchResult::StartIndex equals 3, the first element in the sequence FetchResult::Rows contains the data of the index 3 in the original resultset.  
Orientation indicates the orientation in which the rows are fetched and set into the sequence FetchResult::Rows.  
FetchError indicates whether and which error has occured, while fetching.  
Elements' Details
Rows
sequence< any > Rows;
Description
contains the demanded data.

One any contains the data of one whole row. Those methods which use this struct have to specify, what the any has to contain.

StartIndex
long StartIndex;
Description
indicates the index of the first row contained in FetchResult::Rows in the original resultset. So if FetchResult::StartIndex equals 3, the first element in the sequence FetchResult::Rows contains the data of the index 3 in the original resultset.

The following rows are one after the other, but the direction depends on the value of FetchResult::Direction

Orientation
boolean Orientation;
Description
indicates the orientation in which the rows are fetched and set into the sequence FetchResult::Rows.

When FetchResult::Orientation equals true, the rows in FetchResult::Rows are ordered in the same way as in the original resultset.

FetchError
short FetchError;
Description
indicates whether and which error has occured, while fetching.

The value may contain zero or more constants of the FetchError constants group.

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.