/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: SearchInfo.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 07:49:51 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#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
