offapi/com/sun/star/ucb/SearchInfo.idl

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