KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: WfRequester.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.Iterator JavaDoc;
28 import java.util.List JavaDoc;
29 import java.util.Map JavaDoc;
30
31 import org.ofbiz.service.GenericRequester;
32
33 /**
34  * WfRequester - Workflow Requester Interface
35  *
36  * @author <a HREF="mailto:jaz@ofbiz.org">Andy Zeneski</a>
37  * @version $Rev: 5462 $
38  * @since 2.0
39  */
40 public interface WfRequester {
41
42     /**
43      * Gets the number of processes.
44      * @throws WfException
45      * @return Count of the number of workflow processes
46      */
47     public int howManyPerformer() throws WfException;
48
49     /** Gets an iterator of processes.
50      * @throws WfException
51      * @return Iterator of workflow processes.
52      */
53     public Iterator JavaDoc getIteratorPerformer() throws WfException;
54
55     /**
56      * A list of processes
57      * @param maxNumber
58      * @throws WfException
59      * @return List of WfProcess objects.
60      */
61     public List JavaDoc getSequencePerformer(int maxNumber) throws WfException;
62
63     /**
64      * Checks if a WfProcess is associated with this requester object
65      * @param member
66      * @throws WfException
67      * @return true if the process is found.
68      */
69     public boolean isMemberOfPerformer(WfProcess member) throws WfException;
70
71     /**
72      * Registers a process with this requester; starts the process.
73      *@param process to register
74      *@param context to initialize the process with
75      *@param requester associated with the service
76      *@throws WfException
77      */
78     public void registerProcess(WfProcess process, Map JavaDoc context, GenericRequester requester) throws WfException;
79
80     /**
81      * Receives notice of event status changes
82      * @param event
83      * @throws WfException
84      * @throws InvalidPerformer
85      */
86     public void receiveEvent(WfEventAudit event) throws WfException, InvalidPerformer;
87
88 } // interface WfRequesterOperations
89
Popular Tags