Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * 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;

Represents one unit of work that needs to be executed. It contains all the information that it necessary to execute this unit of work as parameters, and (possibly) results related to its execution. WorkItems represent a unit of work in an abstract, high-level and implementation-independent manner. They are created by the engine whenever an external task needs to be performed. The engine will delegate the work item to the appropriate WorkItemHandler for execution. Whenever a work item is completed (or whenever the work item cannot be executed and should be aborted), the work item manager should be notified. For example, a work item could be created whenever an email needs to be sent. This work item would have a name that represents the type of work that needs to be executed (e.g. "Email") and parameters related to its execution (e.g. "From" = "me@mail.com", "To" = ..., "Body" = ..., ...). Result parameters can contain results related to the execution of this work item (e.g. "Success" = true).

See also:
org.drools.core.runtime.process.WorkItemHandler
org.drools.core.runtime.process.WorkItemManager
 
 public interface WorkItem {
 
     int PENDING   = 0;
     int ACTIVE    = 1;
     int COMPLETED = 2;
     int ABORTED   = 3;

    
The unique id of this work item

Returns:
the id of this work item
 
     long getId();

    
The name of the work item. This represents the type of work that should be executed.

Returns:
the name of the work item
 
     String getName();

    
The state of the work item.

Returns:
the state of the work item
 
     int getState();

    
Returns the value of the parameter with the given name. Parameters can be used to pass information necessary for the execution of this work item. Returns null if the parameter cannot be found.

Parameters:
name the name of the parameter
Returns:
the value of the parameter
 
     Object getParameter(String name);

    
Returns the map of parameters of this work item. Parameters can be used to pass information necessary for the execution of this work item.

Returns:
the map of parameters of this work item
 
     Map<StringObjectgetParameters();

    
Returns the value of the result parameter with the given name. Result parameters can be used to pass information related the result of the execution of this work item. Returns null if the result cannot be found.

Parameters:
name the name of the result parameter
Returns:
the value of the result parameter
 
     Object getResult(String name);

    
Returns the map of result parameters of this work item. Result parameters can be used to pass information related the result of the execution of this work item.

Returns:
the map of results of this work item
    Map<StringObjectgetResults();

    
The id of the process instance that requested the execution of this work item

Returns:
the id of the related process instance
    long getProcessInstanceId();
New to GrepCode? Check out our FAQ X