01: /*******************************************************************************
02: * Licensed to the Apache Software Foundation (ASF) under one
03: * or more contributor license agreements. See the NOTICE file
04: * distributed with this work for additional information
05: * regarding copyright ownership. The ASF licenses this file
06: * to you under the Apache License, Version 2.0 (the
07: * "License"); you may not use this file except in compliance
08: * with the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing,
13: * software distributed under the License is distributed on an
14: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15: * KIND, either express or implied. See the License for the
16: * specific language governing permissions and limitations
17: * under the License.
18: *******************************************************************************/package org.ofbiz.service.engine;
19:
20: import java.util.Map;
21:
22: import org.ofbiz.service.GenericRequester;
23: import org.ofbiz.service.GenericServiceException;
24: import org.ofbiz.service.ModelService;
25:
26: /**
27: * Generic Engine Interface
28: */
29: public interface GenericEngine {
30:
31: public static final int ASYNC_MODE = 22;
32: public static final int SYNC_MODE = 21;
33:
34: /**
35: * Run the service synchronously and return the result.
36: *
37: * @param localName Name of the LocalDispatcher.
38: * @param modelService Service model object.
39: * @param context Map of name, value pairs composing the context.
40: * @return Map of name, value pairs composing the result.
41: * @throws GenericServiceException
42: */
43: public Map runSync(String localName, ModelService modelService,
44: Map context) throws GenericServiceException;
45:
46: /**
47: * Run the service synchronously and IGNORE the result.
48: *
49: * @param localName Name of the LocalDispatcher.
50: * @param modelService Service model object.
51: * @param context Map of name, value pairs composing the context.
52: * @throws GenericServiceException
53: */
54: public void runSyncIgnore(String localName,
55: ModelService modelService, Map context)
56: throws GenericServiceException;
57:
58: /**
59: * Run the service asynchronously, passing an instance of GenericRequester that will receive the result.
60: *
61: * @param localName Name of the LocalDispatcher.
62: * @param modelService Service model object.
63: * @param context Map of name, value pairs composing the context.
64: * @param requester Object implementing GenericRequester interface which will receive the result.
65: * @param persist True for store/run; False for run.
66: * @throws GenericServiceException
67: */
68: public void runAsync(String localName, ModelService modelService,
69: Map context, GenericRequester requester, boolean persist)
70: throws GenericServiceException;
71:
72: /**
73: * Run the service asynchronously and IGNORE the result.
74: *
75: * @param localName Name of the LocalDispatcher.
76: * @param modelService Service model object.
77: * @param context Map of name, value pairs composing the context.
78: * @param persist True for store/run; False for run.
79: * @throws GenericServiceException
80: */
81: public void runAsync(String localName, ModelService modelService,
82: Map context, boolean persist)
83: throws GenericServiceException;
84:
85: /**
86: * Send the service callbacks
87: * @param modelService Service model object
88: * @param context Map of name, value pairs composing the context
89: * @param cbObj Object to return to callback (Throwable or Map)
90: * @param mode Service mode (sync or async)
91: * @throws GenericServiceException
92: */
93: public void sendCallbacks(ModelService modelService, Map context,
94: Object cbObj, int mode) throws GenericServiceException;
95: }
|