KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: WfProcessMgr.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 import java.util.Map JavaDoc;
28 import java.util.Iterator JavaDoc;
29 import java.util.List JavaDoc;
30
31 /**
32  * WfProcessMgr - Workflow Process Manager Interface
33  *
34  * @author <a HREF="mailto:jaz@ofbiz.org">Andy Zeneski</a>
35  * @version $Rev: 5462 $
36  * @since 2.0
37  */
38 public interface WfProcessMgr {
39
40     /**
41      * @throws WfException
42      * @return
43      */
44     public int howManyProcess() throws WfException;
45
46     /**
47      * @throws WfException
48      * @return
49      */
50     public Iterator JavaDoc getIteratorProcess() throws WfException;
51
52     /**
53      * @param maxNumber
54      * @throws WfException
55      * @return List of WfProcess objects.
56      */
57     public List JavaDoc getSequenceProcess(int maxNumber) throws WfException;
58
59     /**
60      * @param member
61      * @throws WfException
62      * @return
63      */
64     public boolean isMemberOfProcess(WfProcess member) throws WfException;
65
66     /**
67      * @throws WfException
68      * @return
69      */
70     public List JavaDoc processMgrStateType() throws WfException;
71
72     /**
73      * @param newState
74      * @throws WfException
75      * @throws TransitionNotAllowed
76      */
77     public void setProcessMgrState(String JavaDoc newState) throws WfException, TransitionNotAllowed;
78
79     /**
80      * @throws WfException
81      * @return
82      */
83     public String JavaDoc name() throws WfException;
84
85     /**
86      * @throws WfException
87      * @return
88      */
89     public String JavaDoc description() throws WfException;
90
91     /**
92      * @throws WfException
93      * @return
94      */
95     public String JavaDoc category() throws WfException;
96
97     /**
98      * @throws WfException
99      * @return
100      */
101     public String JavaDoc version() throws WfException;
102
103     /**
104      * @throws WfException
105      * @return
106      */
107     public Map JavaDoc contextSignature() throws WfException;
108
109     /**
110      * @throws WfException
111      * @return
112      */
113     public Map JavaDoc resultSignature() throws WfException;
114
115     /**
116     * @throws WfException
117     * @return initial context based on DataFields
118     */
119     public Map JavaDoc getInitialContext() throws WfException;
120
121     /**
122      * Create a WfProcess object
123      * @param requester
124      * @throws WfException
125      * @throws NotEnabled
126      * @throws InvalidRequester
127      * @throws RequesterRequired
128      * @return WfProcess created
129      */
130     public WfProcess createProcess(WfRequester requester)
131         throws WfException, NotEnabled, InvalidRequester, RequesterRequired;
132
133 } // interface WfProcessMgr
134
Popular Tags