public class CommandFactory extends Object
The CommandFactory returns Commands that can be used by classes that implement CommandExecutor. Typically more than one Command will want to be executed, where is where the BatchExecution comes in, which takes a List of commands, think of it as CompositeCommand.
Out of the box marshalling to XML is support for the Commands, specifically the BatchExecution command and ExecutionResults, using the Drools Pipeline. If the drools-pipeline module is added then the PipelineFactory can be used in conjunction with the BatchExecutionHelper to marshall to and from XML. BatchExecutionHelper also provides additional documentation on the supported XML format.
`This api is experimental and thus the classes and the interfaces returned are subject to change.
Constructor and Description |
---|
CommandFactory() |
Modifier and Type | Method and Description |
---|---|
static org.kie.api.command.Command<org.kie.api.runtime.rule.FactHandle> |
fromExternalFactHandleCommand(String factHandleExternalForm) |
static org.kie.api.command.Command<org.kie.api.runtime.rule.FactHandle> |
fromExternalFactHandleCommand(String factHandleExternalForm,
boolean disconnected) |
static org.kie.api.command.Command |
newAbortWorkItem(long workItemId) |
static org.kie.api.command.BatchExecutionCommand |
newBatchExecution(List<? extends org.kie.api.command.Command> commands)
This is a special composite command and will execute all the supplied commands in turn.
|
static org.kie.api.command.BatchExecutionCommand |
newBatchExecution(List<? extends org.kie.api.command.Command> commands,
String lookup) |
static org.kie.api.command.Command |
newCompleteWorkItem(long workItemId,
Map<String,Object> results) |
static org.kie.api.command.Command |
newDelete(org.kie.api.runtime.rule.FactHandle factHandle) |
static org.kie.api.command.Command |
newDeleteObject(Object object,
String entryPoint) |
static org.kie.api.command.Command |
newFireAllRules() |
static org.kie.api.command.Command |
newFireAllRules(int max) |
static org.kie.api.command.Command |
newFireAllRules(String outidentifier) |
static org.kie.api.command.Command |
newGetFactHandle(Object object) |
static org.kie.api.command.Command |
newGetFactHandleInEntryPoint(Object object,
String entryPoint) |
static org.kie.api.command.Command |
newGetGlobal(String identifier)
Gets the global and adds it to the ExecutionResults
|
static org.kie.api.command.Command |
newGetGlobal(String identifier,
String outIdentifier)
Gets the global and adds it ot the BatchExecutionresults using the alternative outIdentifier.
|
static org.kie.api.command.Command |
newGetObject(org.kie.api.runtime.rule.FactHandle factHandle) |
static org.kie.api.command.Command |
newGetObject(org.kie.api.runtime.rule.FactHandle factHandle,
String outIdentifier) |
static org.kie.api.command.Command |
newGetObjects() |
static org.kie.api.command.Command |
newGetObjects(org.kie.api.runtime.ObjectFilter filter) |
static org.kie.api.command.Command |
newGetObjects(org.kie.api.runtime.ObjectFilter filter,
String outIdentifier) |
static org.kie.api.command.Command |
newGetObjects(String outIdentifier) |
static org.kie.api.command.Command |
newInsert(Object object)
Inserts a new instance
|
static org.kie.api.command.Command |
newInsert(Object object,
String outIdentifier)
Inserts a new instance but references via the outIdentifier, which is returned as part of the ExecutionResults
|
static org.kie.api.command.Command |
newInsert(Object object,
String outIdentifier,
boolean returnObject,
String entryPoint)
Inserts a new instance but references via the outIdentifier, which is returned as part of the ExecutionResults
The outIdentifier can be null.
|
static org.kie.api.command.Command |
newInsertElements(Collection objects)
Iterate and insert each of the elements of the Collection.
|
static org.kie.api.command.Command |
newInsertElements(Collection objects,
String outIdentifier,
boolean returnObject,
String entryPoint)
Iterate and insert each of the elements of the Collection.
|
static org.kie.api.command.Command |
newModify(org.kie.api.runtime.rule.FactHandle factHandle,
List<org.kie.api.command.Setter> setters) |
static org.kie.api.command.Command |
newQuery(String identifier,
String name)
Executes a query.
|
static org.kie.api.command.Command |
newQuery(String identifier,
String name,
Object[] arguments)
Executes a query using the given parameters.
|
static org.kie.api.command.Command |
newRegisterWorkItemHandlerCommand(org.kie.api.runtime.process.WorkItemHandler handler,
String workItemName) |
static org.kie.api.command.Command |
newSetGlobal(String identifier,
Object object)
Sets the global.
|
static org.kie.api.command.Command |
newSetGlobal(String identifier,
Object object,
boolean out)
Sets the global but also when the out parameter is true specifies that the global is added to the ExecutionResults.
|
static org.kie.api.command.Command |
newSetGlobal(String identifier,
Object object,
String outIdentifier)
Sets the global but also specifies that the global is added to the ExecutionResults.
|
static org.kie.api.command.Setter |
newSetter(String accessor,
String value) |
static org.kie.api.command.Command |
newSignalEvent(long processInstanceId,
String type,
Object event) |
static org.kie.api.command.Command |
newSignalEvent(String type,
Object event) |
static org.kie.api.command.Command |
newStartProcess(String processId)
Start a process
|
static org.kie.api.command.Command |
newStartProcess(String processId,
Map<String,Object> parameters)
Start a process using the given parameters.
|
public static org.kie.api.command.Command newInsert(Object object)
object
- public static org.kie.api.command.Command newInsert(Object object, String outIdentifier)
object
- outIdentifier
- public static org.kie.api.command.Command newInsert(Object object, String outIdentifier, boolean returnObject, String entryPoint)
object
- outIdentifier
- entryPoint
- public static org.kie.api.command.Command newInsertElements(Collection objects)
objects
- The objects to insertpublic static org.kie.api.command.Command newInsertElements(Collection objects, String outIdentifier, boolean returnObject, String entryPoint)
objects
- The objects to insertoutIdentifier
- Identifier to lookup the returned objectsreturnObject
- boolean to specify whether the inserted Collection is part of the ExecutionResultsentryPoint
- Optional EntryPoint for the insertionspublic static org.kie.api.command.Command newDelete(org.kie.api.runtime.rule.FactHandle factHandle)
public static org.kie.api.command.Command newDeleteObject(Object object, String entryPoint)
public static org.kie.api.command.Command newGetFactHandle(Object object)
public static org.kie.api.command.Command newGetFactHandleInEntryPoint(Object object, String entryPoint)
public static org.kie.api.command.Command newModify(org.kie.api.runtime.rule.FactHandle factHandle, List<org.kie.api.command.Setter> setters)
public static org.kie.api.command.Command newGetObject(org.kie.api.runtime.rule.FactHandle factHandle)
public static org.kie.api.command.Command newGetObject(org.kie.api.runtime.rule.FactHandle factHandle, String outIdentifier)
public static org.kie.api.command.Command newGetObjects()
public static org.kie.api.command.Command newGetObjects(String outIdentifier)
public static org.kie.api.command.Command newGetObjects(org.kie.api.runtime.ObjectFilter filter)
public static org.kie.api.command.Command newGetObjects(org.kie.api.runtime.ObjectFilter filter, String outIdentifier)
public static org.kie.api.command.Command newSetGlobal(String identifier, Object object)
identifier
- The identifier of the globalobject
- The instance to be set as the global.public static org.kie.api.command.Command newSetGlobal(String identifier, Object object, boolean out)
identifier
- The identifier of the globalobject
- The instance to be set as the global.out
- When true the global will be added to the ExecutionResults using the global's identifier.public static org.kie.api.command.Command newSetGlobal(String identifier, Object object, String outIdentifier)
identifier
- The identifier of the globalobject
- The instance to be set as the global.outIdentifier
- The identifier used to store the global in the ExecutionResultspublic static org.kie.api.command.Command newGetGlobal(String identifier)
identifier
- public static org.kie.api.command.Command newGetGlobal(String identifier, String outIdentifier)
identifier
- The identifier of the globaloutIdentifier
- The identifier used in the ExecutionResults to store the global.public static org.kie.api.command.Command newFireAllRules()
public static org.kie.api.command.Command newFireAllRules(int max)
public static org.kie.api.command.Command newFireAllRules(String outidentifier)
public static org.kie.api.command.Command newStartProcess(String processId)
processId
- public static org.kie.api.command.Command newStartProcess(String processId, Map<String,Object> parameters)
processId
- parameters
- public static org.kie.api.command.Command newSignalEvent(long processInstanceId, String type, Object event)
public static org.kie.api.command.Command newRegisterWorkItemHandlerCommand(org.kie.api.runtime.process.WorkItemHandler handler, String workItemName)
public static org.kie.api.command.Command newCompleteWorkItem(long workItemId, Map<String,Object> results)
public static org.kie.api.command.Command newAbortWorkItem(long workItemId)
public static org.kie.api.command.Command newQuery(String identifier, String name)
identifier
- The identifier to be used for the results when added to the ExecutionResultsname
- The name of the query to executepublic static org.kie.api.command.Command newQuery(String identifier, String name, Object[] arguments)
identifier
- The identifier to be used for the results when added to the ExecutionResultsname
- The name of the query to executearguments
- The arguments to be used for the query parameterspublic static org.kie.api.command.BatchExecutionCommand newBatchExecution(List<? extends org.kie.api.command.Command> commands)
commands
- public static org.kie.api.command.BatchExecutionCommand newBatchExecution(List<? extends org.kie.api.command.Command> commands, String lookup)
public static org.kie.api.command.Command<org.kie.api.runtime.rule.FactHandle> fromExternalFactHandleCommand(String factHandleExternalForm)
public static org.kie.api.command.Command<org.kie.api.runtime.rule.FactHandle> fromExternalFactHandleCommand(String factHandleExternalForm, boolean disconnected)
Copyright © 2001–2016 JBoss by Red Hat. All rights reserved.