xref: /aoo41x/main/offapi/com/sun/star/ucb/RuleSet.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_ucb_RuleSet_idl__
28#define __com_sun_star_ucb_RuleSet_idl__
29
30#ifndef __com_sun_star_ucb_Rule_idl__
31#include <com/sun/star/ucb/Rule.idl>
32#endif
33
34
35//=============================================================================
36
37module com { module sun { module star { module ucb {
38
39//=============================================================================
40/** describes a set of <type>Rule</type>s.
41
42    <p>A RuleSet is applied to a folder. It consists of a sequence of rules.
43	Each rule consists of a sequence of <type>RuleTerm</type>s describing the
44	objects to which the rule should by applied and the <type>RuleAction</type>
45	which should be performed on the matching objects.
46*/
47published struct RuleSet
48{
49	//-------------------------------------------------------------------------
50	/** conatains a number of rules.
51	*/
52	sequence<com::sun::star::ucb::Rule> Rules;
53
54	//-------------------------------------------------------------------------
55	/** is a flag indicating whether the rules apply to folders, too.
56	*/
57	boolean HandleFolder;
58
59};
60
61//=============================================================================
62
63}; }; }; };
64
65#endif
66