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_SearchInfo_idl__ 24#define __com_sun_star_ucb_SearchInfo_idl__ 25 26#ifndef __com_sun_star_ucb_SearchCriterium_idl__ 27#include <com/sun/star/ucb/SearchCriterium.idl> 28#endif 29 30#ifndef __com_sun_star_ucb_SearchRecursion_idl__ 31#include <com/sun/star/ucb/SearchRecursion.idl> 32#endif 33 34 35//============================================================================= 36 37module com { module sun { module star { module ucb { 38 39//============================================================================= 40/** information needed to (recursively) search an object. 41*/ 42published struct SearchInfo 43{ 44 //------------------------------------------------------------------------- 45 /** the search criteria. 46 */ 47 sequence<com::sun::star::ucb::SearchCriterium> Criteria; 48 49 //------------------------------------------------------------------------- 50 /** the mode of recursion to use. 51 */ 52 com::sun::star::ucb::SearchRecursion Recursion; 53 54 //------------------------------------------------------------------------- 55 /** whether to include the object itself in the search or only (some of) 56 its sub-objects. 57 */ 58 boolean IncludeBase; 59 60 //------------------------------------------------------------------------- 61 /** whether to respect the "view restrictions" specified for the folders 62 hierarchically contained within an object (e.g., only searches through 63 subscribed folders). 64 */ 65 boolean RespectFolderViewRestrictions; 66 67 //------------------------------------------------------------------------- 68 /** whether to respect the "view restrictions" specified for the documents 69 hierarchically contained within an object (e.g., only searches through 70 marked documents). 71 */ 72 boolean RespectDocViewRestrictions; 73 74 //------------------------------------------------------------------------- 75 /** whether to follow indirections (link objects) and search through their 76 respective targets also. 77 */ 78 boolean FollowIndirections; 79 80}; 81 82//============================================================================= 83 84}; }; }; }; 85 86#endif 87