summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/SearchInfo.idl
blob: 5137db204c5cd93ed2d9151287f6b9de967959c4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_SearchInfo_idl__
#define __com_sun_star_ucb_SearchInfo_idl__

#ifndef __com_sun_star_ucb_SearchCriterium_idl__
#include <com/sun/star/ucb/SearchCriterium.idl>
#endif

#ifndef __com_sun_star_ucb_SearchRecursion_idl__
#include <com/sun/star/ucb/SearchRecursion.idl>
#endif


//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** information needed to (recursively) search an object.
*/
published struct SearchInfo
{
    //-------------------------------------------------------------------------
    /** the search criteria.
    */
    sequence<com::sun::star::ucb::SearchCriterium> Criteria;

    //-------------------------------------------------------------------------
    /** the mode of recursion to use.
    */
    com::sun::star::ucb::SearchRecursion Recursion;

    //-------------------------------------------------------------------------
    /** whether to include the object itself in the search or only (some of)
        its sub-objects.
    */
    boolean IncludeBase;

    //-------------------------------------------------------------------------
    /** whether to respect the "view restrictions" specified for the folders
        hierarchically contained within an object (e.g., only searches through
        subscribed folders).
    */
    boolean RespectFolderViewRestrictions;

    //-------------------------------------------------------------------------
    /** whether to respect the "view restrictions" specified for the documents
        hierarchically contained within an object (e.g., only searches through
        marked documents).
    */
    boolean RespectDocViewRestrictions;

    //-------------------------------------------------------------------------
    /** whether to follow indirections (link objects) and search through their
        respective targets also.
    */
    boolean FollowIndirections;

};

//=============================================================================

}; }; }; };

#endif