blob: 213ac28b1f3dd18422391ce94da9787813d4c45e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_ucb_Rule_idl__
#define __com_sun_star_ucb_Rule_idl__
#ifndef __com_sun_star_ucb_RuleTerm_idl__
#include <com/sun/star/ucb/RuleTerm.idl>
#endif
//=============================================================================
module com { module sun { module star { module ucb {
//=============================================================================
/** describes a rule that can be applies to a number of objects.
<p>A rule consists of a sequence of <type>RuleTerm</type>s describing the
objects to which the rule should be applied, the <type>RuleAction</type>
which should be used on the matching objects, and a parameter.
*/
published struct Rule
{
//-------------------------------------------------------------------------
/** the rule terms describing the objects to which the rule should be
applied.
*/
sequence<com::sun::star::ucb::RuleTerm> Terms;
//-------------------------------------------------------------------------
/** Some <type>RuleAction</type>s require a parameter.
<table border =1>
<tr>
<th>Action</th>
<th>Parameter</th>
</tr>
<tr>
<td>COPY, MOVE, LINK</td>
<td>The URL to the destination folder.</td>
</tr>
<tr>
<td>FORWARD</td>
<td>The email address of the recepient</td>
</tr>
<tr>
<td>All other actions</td>
<td>n/a</td>
</tr>
</table>
*/
string Parameter;
//-------------------------------------------------------------------------
/** the action to perform on the matching objects.
<p>The value can be one of the <type>RuleAction</type> constants.
*/
short Action;
};
//=============================================================================
}; }; }; };
#endif
|
