xref: /aoo42x/main/offapi/com/sun/star/ucb/SearchInfo.idl (revision cdf0e10c)
1*cdf0e10cSrcweir/*************************************************************************
2*cdf0e10cSrcweir *
3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir *
5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir *
7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir *
9*cdf0e10cSrcweir * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir *
11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir *
15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir *
21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir *
26*cdf0e10cSrcweir ************************************************************************/
27*cdf0e10cSrcweir#ifndef __com_sun_star_ucb_SearchInfo_idl__
28*cdf0e10cSrcweir#define __com_sun_star_ucb_SearchInfo_idl__
29*cdf0e10cSrcweir
30*cdf0e10cSrcweir#ifndef __com_sun_star_ucb_SearchCriterium_idl__
31*cdf0e10cSrcweir#include <com/sun/star/ucb/SearchCriterium.idl>
32*cdf0e10cSrcweir#endif
33*cdf0e10cSrcweir
34*cdf0e10cSrcweir#ifndef __com_sun_star_ucb_SearchRecursion_idl__
35*cdf0e10cSrcweir#include <com/sun/star/ucb/SearchRecursion.idl>
36*cdf0e10cSrcweir#endif
37*cdf0e10cSrcweir
38*cdf0e10cSrcweir
39*cdf0e10cSrcweir//=============================================================================
40*cdf0e10cSrcweir
41*cdf0e10cSrcweirmodule com { module sun { module star { module ucb {
42*cdf0e10cSrcweir
43*cdf0e10cSrcweir//=============================================================================
44*cdf0e10cSrcweir/** information needed to (recursively) search an object.
45*cdf0e10cSrcweir*/
46*cdf0e10cSrcweirpublished struct SearchInfo
47*cdf0e10cSrcweir{
48*cdf0e10cSrcweir	//-------------------------------------------------------------------------
49*cdf0e10cSrcweir	/** the search criteria.
50*cdf0e10cSrcweir	*/
51*cdf0e10cSrcweir	sequence<com::sun::star::ucb::SearchCriterium> Criteria;
52*cdf0e10cSrcweir
53*cdf0e10cSrcweir	//-------------------------------------------------------------------------
54*cdf0e10cSrcweir	/** the mode of recursion to use.
55*cdf0e10cSrcweir	*/
56*cdf0e10cSrcweir	com::sun::star::ucb::SearchRecursion Recursion;
57*cdf0e10cSrcweir
58*cdf0e10cSrcweir	//-------------------------------------------------------------------------
59*cdf0e10cSrcweir	/** whether to include the object itself in the search or only (some of)
60*cdf0e10cSrcweir		its sub-objects.
61*cdf0e10cSrcweir	*/
62*cdf0e10cSrcweir	boolean IncludeBase;
63*cdf0e10cSrcweir
64*cdf0e10cSrcweir	//-------------------------------------------------------------------------
65*cdf0e10cSrcweir	/** whether to respect the "view restrictions" specified for the folders
66*cdf0e10cSrcweir		hierarchically contained within an object (e.g., only searches through
67*cdf0e10cSrcweir		subscribed folders).
68*cdf0e10cSrcweir	*/
69*cdf0e10cSrcweir	boolean RespectFolderViewRestrictions;
70*cdf0e10cSrcweir
71*cdf0e10cSrcweir	//-------------------------------------------------------------------------
72*cdf0e10cSrcweir	/** whether to respect the "view restrictions" specified for the documents
73*cdf0e10cSrcweir		hierarchically contained within an object (e.g., only searches through
74*cdf0e10cSrcweir		marked documents).
75*cdf0e10cSrcweir	*/
76*cdf0e10cSrcweir	boolean RespectDocViewRestrictions;
77*cdf0e10cSrcweir
78*cdf0e10cSrcweir	//-------------------------------------------------------------------------
79*cdf0e10cSrcweir	/** whether to follow indirections (link objects) and search through their
80*cdf0e10cSrcweir		respective targets also.
81*cdf0e10cSrcweir	*/
82*cdf0e10cSrcweir	boolean FollowIndirections;
83*cdf0e10cSrcweir
84*cdf0e10cSrcweir};
85*cdf0e10cSrcweir
86*cdf0e10cSrcweir//=============================================================================
87*cdf0e10cSrcweir
88*cdf0e10cSrcweir}; }; }; };
89*cdf0e10cSrcweir
90*cdf0e10cSrcweir#endif
91