Rule Execution Server API

ilog.rules.factory
Class IlrFlowTaskFactory

java.lang.Object
  extended by ilog.rules.factory.IlrTaskFactory
      extended by ilog.rules.factory.IlrFlowTaskFactory
All Implemented Interfaces:
ilog.rules.factory.IlrRulesetElement, IlrTaskElement, Serializable

public class IlrFlowTaskFactory
extends IlrTaskFactory

This class represents the class of a flow-based task definition of the IRL language. It provides the specific body as flow described in extended IRL code.

Warning: Serialized objects of this class will not be compatible with future releases. The current serialization support is appropriate for short-term storage or RMI between applications running the same version of IBM Decision Server.

See Also:
IlrRuleTaskFactory, IlrFunctionTaskFactory, IlrFlowTaskFactory, Serialized Form

Constructor Summary
IlrFlowTaskFactory(IlrReflect reflect, IlrPackageFactory pkg, String name)
           Builds a flow-based task by specifying a reflect, a package and a name.
IlrFlowTaskFactory(IlrReflect reflect, String name)
          Deprecated. Use instead IlrFlowTaskFactory(IlrReflect reflect, IlrPackageFactory pkg, String name).
 
Method Summary
 void compile()
           Makes checks to insure that the graph is correctly built.
 ArrayList getAllStatements()
          Provides all statements referenced by the task definition.
 boolean hasEmptyBody()
          Indicates whether the task has an empty body or not, that is, if the flow referred by the task is empty.
 void setRoot(IlrFlowNodeStatement root)
          Sets the body of the flow-based task by setting the root node of the flow.
 
Methods inherited from class ilog.rules.factory.IlrTaskFactory
getAllValues, getCompletionFlagValue, getFinalActions, getFormalComment, getInitialActions, getName, getPackage, getProperties, getShortName, setCompletionFlagValue, setFinalActions, setFormalComment, setInitialActions, setProperties
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IlrFlowTaskFactory

public IlrFlowTaskFactory(IlrReflect reflect,
                          String name)
Deprecated. Use instead IlrFlowTaskFactory(IlrReflect reflect, IlrPackageFactory pkg, String name).

Builds a flow-based task by specifying a reflect and a name. The task is considered to belong to the default package. The body is empty.

Parameters:
reflect - The reflect object of this flow-based task factory.
name - The name of the flow-based task.

IlrFlowTaskFactory

public IlrFlowTaskFactory(IlrReflect reflect,
                          IlrPackageFactory pkg,
                          String name)

Builds a flow-based task by specifying a reflect, a package and a name. The task belongs to the specified package. In case the package is null, the task is considered to belong to the default package. The body is empty.

Parameters:
reflect - The reflect object of this flow-based task factory.
pkg - The package to which the task belongs.
name - The name of the flow-based task.
Method Detail

setRoot

public void setRoot(IlrFlowNodeStatement root)
Sets the body of the flow-based task by setting the root node of the flow.

Parameters:
root - The root node of the flow-based task.

compile

public void compile()

Makes checks to insure that the graph is correctly built. This method has to be called once the flow is built in order to make the checks.


hasEmptyBody

public boolean hasEmptyBody()
Indicates whether the task has an empty body or not, that is, if the flow referred by the task is empty.

Specified by:
hasEmptyBody in class IlrTaskFactory
Returns:
true if the task body is empty, or else it returns false.

getAllStatements

public ArrayList getAllStatements()
Provides all statements referenced by the task definition. This method can make a factory exploration by a factory explorer easier. The returned list contains statements. If the task references no statements, the returned list is empty.

Overrides:
getAllStatements in class IlrTaskFactory
Returns:
All the statements referenced by the task.

Rule Execution Server API

© Copyright IBM Corp. 1987, 2013