01: /*--
02:
03: Copyright (C) 2002-2005 Adrian Price.
04: All rights reserved.
05:
06: Redistribution and use in source and binary forms, with or without
07: modification, are permitted provided that the following conditions
08: are met:
09:
10: 1. Redistributions of source code must retain the above copyright
11: notice, this list of conditions, and the following disclaimer.
12:
13: 2. Redistributions in binary form must reproduce the above copyright
14: notice, this list of conditions, and the disclaimer that follows
15: these conditions in the documentation and/or other materials
16: provided with the distribution.
17:
18: 3. The names "OBE" and "Open Business Engine" must not be used to
19: endorse or promote products derived from this software without prior
20: written permission. For written permission, please contact
21: adrianprice@sourceforge.net.
22:
23: 4. Products derived from this software may not be called "OBE" or
24: "Open Business Engine", nor may "OBE" or "Open Business Engine"
25: appear in their name, without prior written permission from
26: Adrian Price (adrianprice@users.sourceforge.net).
27:
28: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
29: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
31: DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
32: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
33: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
34: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
36: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
37: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38: POSSIBILITY OF SUCH DAMAGE.
39:
40: For more information on OBE, please see
41: <http://obe.sourceforge.net/>.
42:
43: */
44:
45: package org.obe.spi;
46:
47: import org.obe.client.api.WMClient;
48: import org.obe.client.api.WMClientFactory;
49: import org.obe.spi.event.ApplicationEvent;
50: import org.obe.spi.service.ServiceManager;
51: import org.wfmc.wapi.WMWorkflowException;
52:
53: /**
54: * Provides local service provider interfaces. The local client returned by
55: * {@link WMClientFactory#createClient(String)} can be cast to this interface in
56: * order to access internal services.
57: *
58: * @author Adrian Price
59: */
60: public interface WMLocalClient extends WMClient {
61: /**
62: * Provides access to OBE internal services.
63: *
64: * @return The service manager.
65: */
66: ServiceManager getServiceManager();
67:
68: /**
69: * Injects a correlated application event into the workflow engine.
70: *
71: * @param event The application event.
72: * @param correlationKeys Correlation keys supplied to the
73: * <code>ApplicationEventBroker</code> by the original subscription.
74: * @throws WMWorkflowException
75: */
76: void raiseEvent(ApplicationEvent event, String[] correlationKeys)
77: throws WMWorkflowException;
78:
79: /**
80: * Refreshes the work items for all open activities in a process instance.
81: * For each open activity, it re-resolves the performer list against the
82: * participant repository, and ensures that work items exist for all
83: * assigness of the activity.
84: *
85: * @param processInstanceId The ID of the process instance for which work
86: * items are to be refreshed.
87: * @throws WMWorkflowException
88: */
89: void refreshWorkItems(String processInstanceId)
90: throws WMWorkflowException;
91: }
|