/*************************************************************************
 *
 *  $RCSfile: RuleAction.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: kso $ $Date: 2001/02/12 15:53:18 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_RuleAction_idl__
#define __com_sun_star_ucb_RuleAction_idl__


//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/**  These are the possible values for <member>Rule::Action</member>.

	 @see RuleSet
*/
constants RuleAction
{
	//-------------------------------------------------------------------------
	/** "None" - Do nothing.
	*/
	const short NONE = 0;

	//-------------------------------------------------------------------------
	/** "Show" - Shows object when term matches.
	*/
	const short SHOW = 1;

	//-------------------------------------------------------------------------
	/** "Hide" - Hides object when term matches.
	*/
	const short HIDE = 2;

	//-------------------------------------------------------------------------
	/** "Mark" - Marks object when term matches.
	*/
	const short MARK = 3;

	//-------------------------------------------------------------------------
	/** "UnMark" - Removes mark from object when term matches.
	*/
	const short UNMARK = 4;

	//-------------------------------------------------------------------------
	/** "MarkRead" - Marks object as read when term matches.
	*/
	const short MARKREAD = 5;

	//-------------------------------------------------------------------------
	/** "MarkUnRead" - Marks object as not read when term matches.
	*/
	const short MARKUNREAD = 6;

	//-------------------------------------------------------------------------
	/** "Move" - Moves object to <member>Rule::Parameter</member> when term
	    matches.
	*/
	const short MOVE = 7;

	//-------------------------------------------------------------------------
	/** "Copy" - Copies object to <member>Rule::Parameter</member> when term
	    matches.
	*/
	const short COPY = 8;

	//-------------------------------------------------------------------------
	/** "Delete" - Deletes object when term matches.
	*/
	const short DELETE = 9;

	//-------------------------------------------------------------------------
	/** "Link" - Creates a link to <member>Rule::Parameter</member> when term
	    matches.
	*/
	const short LINK = 10;

	//-------------------------------------------------------------------------
	/** "Forward" - Forwards object to <member>Rule::Parameter</member> when
	    term matches.
	*/
	const short FORWARD = 11;

};

//=============================================================================

}; }; }; };

#endif
