offapi/com/sun/star/ucb/RuleSet.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: RuleSet.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_RuleSet_idl__
  31 #define __com_sun_star_ucb_RuleSet_idl__
  32
  33 #ifndef __com_sun_star_ucb_Rule_idl__
  34 #include <com/sun/star/ucb/Rule.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module ucb {
  41
  42 //=============================================================================
  43 /** describes a set of <type>Rule</type>s.
  44
  45     <p>A RuleSet is applied to a folder. It consists of a sequence of rules.
  46     Each rule consists of a sequence of <type>RuleTerm</type>s describing the
  47     objects to which the rule should by applied and the <type>RuleAction</type>
  48     which should be performed on the matching objects.
  49 */
  50 published struct RuleSet
  51 {
  52     //-------------------------------------------------------------------------
  53     /** conatains a number of rules.
  54     */
  55     sequence<com::sun::star::ucb::Rule> Rules;
  56
  57     //-------------------------------------------------------------------------
  58     /** is a flag indicating whether the rules apply to folders, too.
  59     */
  60     boolean HandleFolder;
  61
  62 };
  63
  64 //=============================================================================
  65
  66 }; }; }; };
  67
  68 #endif