1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_ucb_XFetchProviderForContentAccess_idl__ 24#define __com_sun_star_ucb_XFetchProviderForContentAccess_idl__ 25 26#ifndef __com_sun_star_uno_XInterface_idl__ 27#include <com/sun/star/uno/XInterface.idl> 28#endif 29 30#ifndef __com_sun_star_ucb_FetchResult_idl__ 31#include <com/sun/star/ucb/FetchResult.idl> 32#endif 33 34//============================================================================= 35 36module com { module sun { module star { module ucb { 37 38//============================================================================= 39/** provides the possibility to load information offered by a 40 <type>XContentAccess</type> for several rows of a 41 <type>ContentResultSet</type> with a single function call. 42*/ 43published interface XFetchProviderForContentAccess: com::sun::star::uno::XInterface 44{ 45 //------------------------------------------------------------------------- 46 /** returns the content identifier strings of the columns of the indicated 47 rows 48 49 @returns 50 <member>FetchResult::Rows</member> contains a sequence of anys. Each 51 of these anys contains a string. 52 53 @param nRowStartPosition 54 the starting row of the resultset 55 56 @param nRowCount 57 the count of rows 58 59 @param bDirection 60 <TRUE/>, if you want the rows to be read in the same order, as they 61 are contained in the result set ( <TRUE/> <-> forward step; 62 <FALSE/> <-> backward step ) 63 */ 64 com::sun::star::ucb::FetchResult 65 fetchContentIdentifierStrings( [in] long nRowStartPosition 66 , [in] long nRowCount 67 , [in] boolean bDirection ); 68 69 //------------------------------------------------------------------------- 70 /** returns the <type>XContentIdentifier</type>s of the columns of the 71 indicated rows 72 73 @returns 74 <member>FetchResult::Rows</member> contains a sequence of anys. Each 75 of these anys contains an <type>XContentIdentifier</type>. 76 77 @param nRowStartPosition 78 the starting row of the resultset 79 80 @param nRowCount 81 the count of rows 82 83 @param bDirection 84 <TRUE/>, if you want the rows to be read in the same order, as they 85 are contained in the result set ( <TRUE/> <-> forward step; 86 <FALSE/> <-> backward step ) 87 */ 88 com::sun::star::ucb::FetchResult 89 fetchContentIdentifiers( [in] long nRowStartPosition 90 , [in] long nRowCount 91 , [in] boolean bDirection ); 92 93 //------------------------------------------------------------------------- 94 /** returns the <type>XContent</types>s of the columns of the indicated rows 95 96 @returns 97 <member>FetchResult::Rows</member> contains a sequence of anys. Each 98 of these anys contains an <type>XContent</type>. 99 100 @param nRowStartPosition 101 the starting row of the resultset 102 103 @param nRowCount 104 the count of rows 105 106 @param bDirection 107 <TRUE/>, if you want the rows to be read in the same order, as they 108 are contained in the result set ( <TRUE/> <-> forward step; 109 <FALSE/> <-> backward step ) 110 */ 111 com::sun::star::ucb::FetchResult 112 fetchContents( [in] long nRowStartPosition 113 , [in] long nRowCount 114 , [in] boolean bDirection ); 115}; 116 117//============================================================================= 118 119}; }; }; }; 120 121#endif 122