xref: /aoo4110/main/offapi/com/sun/star/ucb/RuleSet.idl (revision b1cdbd2c) 
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_RuleSet_idl__
24#define __com_sun_star_ucb_RuleSet_idl__
25
26#ifndef __com_sun_star_ucb_Rule_idl__
27#include <com/sun/star/ucb/Rule.idl>
28#endif
29
30
31//=============================================================================
32
33module com { module sun { module star { module ucb {
34
35//=============================================================================
36/** describes a set of <type>Rule</type>s.
37
38    <p>A RuleSet is applied to a folder. It consists of a sequence of rules.
39	Each rule consists of a sequence of <type>RuleTerm</type>s describing the
40	objects to which the rule should by applied and the <type>RuleAction</type>
41	which should be performed on the matching objects.
42*/
43published struct RuleSet
44{
45	//-------------------------------------------------------------------------
46	/** conatains a number of rules.
47	*/
48	sequence<com::sun::star::ucb::Rule> Rules;
49
50	//-------------------------------------------------------------------------
51	/** is a flag indicating whether the rules apply to folders, too.
52	*/
53	boolean HandleFolder;
54
55};
56
57//=============================================================================
58
59}; }; }; };
60
61#endif
62