KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > infoglue > cms > applications > workflowtool > function > PropertysetCleaner


1 /* ===============================================================================
2 *
3 * Part of the InfoGlue Content Management Platform (www.infoglue.org)
4 *
5 * ===============================================================================
6 *
7 * Copyright (C)
8 *
9 * This program is free software; you can redistribute it and/or modify it under
10 * the terms of the GNU General Public License version 2, as published by the
11 * Free Software Foundation. See the file LICENSE.html for more information.
12 *
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY, including the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along with
18 * this program; if not, write to the Free Software Foundation, Inc. / 59 Temple
19 * Place, Suite 330 / Boston, MA 02111-1307 / USA.
20 *
21 * ===============================================================================
22 */
23 package org.infoglue.cms.applications.workflowtool.function;
24
25 import com.opensymphony.workflow.WorkflowException;
26
27 /**
28  * This function is used for cleaning the propertyset before terminating a workflow.
29  *
30  * <h1 class="workflow">Context in</h1>
31  * <p>None.</p>
32  * <h1 class="workflow">Context out</h1>
33  * <p>None.</p>
34  */
35 public class PropertysetCleaner extends InfoglueFunction
36 {
37     /**
38      * Default constructor.
39      */
40     public PropertysetCleaner()
41     {
42         super();
43     }
44
45     /**
46      * Removes all data from the propertyset associated with the workflow.
47      *
48      * @throws WorkflowException if an exception occurs while cleaning the propertyset.
49      */
50     protected final void execute() throws WorkflowException
51     {
52         removeFromPropertySet(null);
53     }
54 }
55
Popular Tags