KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > ofbiz > workflow > WfAssignment


1 /*
2  * $Id: WfAssignment.java 5462 2005-08-05 18:35:48Z jonesde $
3  *
4  * Copyright (c) 2001, 2002 The Open For Business Project - www.ofbiz.org
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included
14  * in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
21  * OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  *
24  */
25 package org.ofbiz.workflow;
26
27 /**
28  * WfAssignment - Workflow Assignment Interface
29  *
30  * @author <a HREF="mailto:jaz@ofbiz.org">Andy Zeneski</a>
31  * @version $Rev: 5462 $
32  * @since 2.0
33  */
34 public interface WfAssignment {
35
36     /**
37      * Gets the activity object of this assignment.
38      * @return WfActivity The activity object of this assignment.
39      * @throws WfException
40      */
41     public WfActivity activity() throws WfException;
42
43     /**
44      * Gets the assignee (resource) of this assignment.
45      * @return WfResource The assigned resource.
46      * @throws WfException
47      */
48     public WfResource assignee() throws WfException;
49
50     /**
51      * Sets the assignee of this assignment.
52      * @param newValue The new assigned resource.
53      * @throws WfException
54      * @throws InvalidResource
55      */
56     public void setAssignee(WfResource newValue) throws WfException, InvalidResource;
57
58     /**
59      * Gets the from date of this assignment.
60      * @return Timestamp when this assignment first began.
61      * @throws WfException
62      */
63     public java.sql.Timestamp JavaDoc fromDate() throws WfException;
64
65     /**
66      * Mark this assignment as accepted.
67      * @throws WfException
68      */
69     public void accept() throws WfException;
70
71     /**
72      * Set the results of this assignment.
73      * @param Map The results of the assignement.
74      * @throws WfException
75      */
76     public void setResult(java.util.Map JavaDoc results) throws WfException;
77
78     /**
79      * Mark this assignment as complete.
80      * @throws WfException
81      */
82     public void complete() throws WfException;
83
84     /**
85      * Mark this assignment as delegated.
86      * @throws WfException
87      */
88     public void delegate() throws WfException;
89
90     /**
91      * Change the status of this assignment.
92      * @param status The new status.
93      * @throws WfException
94      */
95     public void changeStatus(String JavaDoc status) throws WfException;
96
97     /**
98      * Gets the status of this assignment.
99      * @return String status code for this assignment.
100      * @throws WfException
101      */
102     public String JavaDoc status() throws WfException;
103
104     /**
105      * Removes the stored data for this object.
106      * @throws WfException
107      */
108     public void remove() throws WfException;
109
110 } // interface WfAssignmentOperations
111
Popular Tags