xref: /aoo41x/main/offapi/com/sun/star/ucb/Rule.idl (revision d1766043)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_ucb_Rule_idl__
24cdf0e10cSrcweir#define __com_sun_star_ucb_Rule_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_ucb_RuleTerm_idl__
27cdf0e10cSrcweir#include <com/sun/star/ucb/RuleTerm.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir
31cdf0e10cSrcweir//=============================================================================
32cdf0e10cSrcweir
33cdf0e10cSrcweirmodule com { module sun { module star { module ucb {
34cdf0e10cSrcweir
35cdf0e10cSrcweir//=============================================================================
36cdf0e10cSrcweir/** describes a rule that can be applies to a number of objects.
37cdf0e10cSrcweir
38cdf0e10cSrcweir    <p>A rule consists of a sequence of <type>RuleTerm</type>s describing the
39cdf0e10cSrcweir	objects to which the rule should be applied, the <type>RuleAction</type>
40cdf0e10cSrcweir	which should be used on the matching objects, and a parameter.
41cdf0e10cSrcweir*/
42cdf0e10cSrcweirpublished struct Rule
43cdf0e10cSrcweir{
44cdf0e10cSrcweir	//-------------------------------------------------------------------------
45cdf0e10cSrcweir	/** the rule terms describing the objects to which the rule should be
46cdf0e10cSrcweir	    applied.
47cdf0e10cSrcweir	*/
48cdf0e10cSrcweir	sequence<com::sun::star::ucb::RuleTerm> Terms;
49cdf0e10cSrcweir
50cdf0e10cSrcweir	//-------------------------------------------------------------------------
51cdf0e10cSrcweir	/** Some <type>RuleAction</type>s require a parameter.
52cdf0e10cSrcweir
53cdf0e10cSrcweir		<table border =1>
54cdf0e10cSrcweir		<tr>
55cdf0e10cSrcweir			<th>Action</th>
56cdf0e10cSrcweir		    <th>Parameter</th>
57cdf0e10cSrcweir		</tr>
58cdf0e10cSrcweir		<tr>
59cdf0e10cSrcweir			<td>COPY, MOVE, LINK</td>
60cdf0e10cSrcweir			<td>The URL to the destination folder.</td>
61cdf0e10cSrcweir		</tr>
62cdf0e10cSrcweir		<tr>
63cdf0e10cSrcweir			<td>FORWARD</td>
64cdf0e10cSrcweir		    <td>The email address of the recepient</td>
65cdf0e10cSrcweir		</tr>
66cdf0e10cSrcweir		<tr>
67cdf0e10cSrcweir			<td>All other actions</td>
68cdf0e10cSrcweir		    <td>n/a</td>
69cdf0e10cSrcweir		</tr>
70cdf0e10cSrcweir		</table>
71cdf0e10cSrcweir	*/
72cdf0e10cSrcweir	string Parameter;
73cdf0e10cSrcweir
74cdf0e10cSrcweir	//-------------------------------------------------------------------------
75cdf0e10cSrcweir	/**	the action to perform on the matching objects.
76cdf0e10cSrcweir
77cdf0e10cSrcweir		<p>The value can be one of the <type>RuleAction</type> constants.
78cdf0e10cSrcweir	*/
79cdf0e10cSrcweir	short Action;
80cdf0e10cSrcweir
81cdf0e10cSrcweir};
82cdf0e10cSrcweir
83cdf0e10cSrcweir//=============================================================================
84cdf0e10cSrcweir
85cdf0e10cSrcweir}; }; }; };
86cdf0e10cSrcweir
87cdf0e10cSrcweir#endif
88