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