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_Rule_idl__ 28#define __com_sun_star_ucb_Rule_idl__ 29 30#ifndef __com_sun_star_ucb_RuleTerm_idl__ 31#include <com/sun/star/ucb/RuleTerm.idl> 32#endif 33 34 35//============================================================================= 36 37module com { module sun { module star { module ucb { 38 39//============================================================================= 40/** describes a rule that can be applies to a number of objects. 41 42 <p>A rule consists of a sequence of <type>RuleTerm</type>s describing the 43 objects to which the rule should be applied, the <type>RuleAction</type> 44 which should be used on the matching objects, and a parameter. 45*/ 46published struct Rule 47{ 48 //------------------------------------------------------------------------- 49 /** the rule terms describing the objects to which the rule should be 50 applied. 51 */ 52 sequence<com::sun::star::ucb::RuleTerm> Terms; 53 54 //------------------------------------------------------------------------- 55 /** Some <type>RuleAction</type>s require a parameter. 56 57 <table border =1> 58 <tr> 59 <th>Action</th> 60 <th>Parameter</th> 61 </tr> 62 <tr> 63 <td>COPY, MOVE, LINK</td> 64 <td>The URL to the destination folder.</td> 65 </tr> 66 <tr> 67 <td>FORWARD</td> 68 <td>The email address of the recepient</td> 69 </tr> 70 <tr> 71 <td>All other actions</td> 72 <td>n/a</td> 73 </tr> 74 </table> 75 */ 76 string Parameter; 77 78 //------------------------------------------------------------------------- 79 /** the action to perform on the matching objects. 80 81 <p>The value can be one of the <type>RuleAction</type> constants. 82 */ 83 short Action; 84 85}; 86 87//============================================================================= 88 89}; }; }; }; 90 91#endif 92