xref: /aoo42x/main/offapi/com/sun/star/ucb/Rule.idl (revision cdf0e10c)

/*************************************************************************
 *
 * 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