xref: /aoo42x/main/offapi/com/sun/star/ucb/SearchInfo.idl (revision d1766043)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_ucb_SearchInfo_idl__
24cdf0e10cSrcweir#define __com_sun_star_ucb_SearchInfo_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_ucb_SearchCriterium_idl__
27cdf0e10cSrcweir#include <com/sun/star/ucb/SearchCriterium.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_ucb_SearchRecursion_idl__
31cdf0e10cSrcweir#include <com/sun/star/ucb/SearchRecursion.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir
35cdf0e10cSrcweir//=============================================================================
36cdf0e10cSrcweir
37cdf0e10cSrcweirmodule com { module sun { module star { module ucb {
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir/** information needed to (recursively) search an object.
41cdf0e10cSrcweir*/
42cdf0e10cSrcweirpublished struct SearchInfo
43cdf0e10cSrcweir{
44cdf0e10cSrcweir	//-------------------------------------------------------------------------
45cdf0e10cSrcweir	/** the search criteria.
46cdf0e10cSrcweir	*/
47cdf0e10cSrcweir	sequence<com::sun::star::ucb::SearchCriterium> Criteria;
48cdf0e10cSrcweir
49cdf0e10cSrcweir	//-------------------------------------------------------------------------
50cdf0e10cSrcweir	/** the mode of recursion to use.
51cdf0e10cSrcweir	*/
52cdf0e10cSrcweir	com::sun::star::ucb::SearchRecursion Recursion;
53cdf0e10cSrcweir
54cdf0e10cSrcweir	//-------------------------------------------------------------------------
55cdf0e10cSrcweir	/** whether to include the object itself in the search or only (some of)
56cdf0e10cSrcweir		its sub-objects.
57cdf0e10cSrcweir	*/
58cdf0e10cSrcweir	boolean IncludeBase;
59cdf0e10cSrcweir
60cdf0e10cSrcweir	//-------------------------------------------------------------------------
61cdf0e10cSrcweir	/** whether to respect the "view restrictions" specified for the folders
62cdf0e10cSrcweir		hierarchically contained within an object (e.g., only searches through
63cdf0e10cSrcweir		subscribed folders).
64cdf0e10cSrcweir	*/
65cdf0e10cSrcweir	boolean RespectFolderViewRestrictions;
66cdf0e10cSrcweir
67cdf0e10cSrcweir	//-------------------------------------------------------------------------
68cdf0e10cSrcweir	/** whether to respect the "view restrictions" specified for the documents
69cdf0e10cSrcweir		hierarchically contained within an object (e.g., only searches through
70cdf0e10cSrcweir		marked documents).
71cdf0e10cSrcweir	*/
72cdf0e10cSrcweir	boolean RespectDocViewRestrictions;
73cdf0e10cSrcweir
74cdf0e10cSrcweir	//-------------------------------------------------------------------------
75cdf0e10cSrcweir	/** whether to follow indirections (link objects) and search through their
76cdf0e10cSrcweir		respective targets also.
77cdf0e10cSrcweir	*/
78cdf0e10cSrcweir	boolean FollowIndirections;
79cdf0e10cSrcweir
80cdf0e10cSrcweir};
81cdf0e10cSrcweir
82cdf0e10cSrcweir//=============================================================================
83cdf0e10cSrcweir
84cdf0e10cSrcweir}; }; }; };
85cdf0e10cSrcweir
86cdf0e10cSrcweir#endif
87