org.drools.runtime.process.WorkItemManager Maven / Gradle / Ivy
/**
* Copyright 2010 JBoss Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.drools.runtime.process;
import java.util.Map;
/**
* A work item manager is responsible for finding the right
* work item handler when a work item should be executed and
* should be notified when this work item has been completed
* (or aborted).
*/
public interface WorkItemManager {
/**
* Notifies the work item manager that the work item with the given
* id has been completed. Results related to the execution of this
* work item can be passed.
*
* @param id the id of the work item that has been completed
* @param results the results related to this work item, or null if there are no results
*/
void completeWorkItem(long id,
Map results);
/**
* Notifies the work item manager that the work item with the given
* id could not be executed and should be aborted.
*
* @param id the id of the work item that should be aborted
*/
void abortWorkItem(long id);
/**
* Register the given handler for all work items of the given
* type of work
*
* @param workItemName the type of work this work item handler can execute
* @param handler the handler for executing work items
*/
void registerWorkItemHandler(String workItemName,
WorkItemHandler handler);
}