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