offapi/com/sun/star/ucb/Rule.idl

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