IlrRuleflow (Decision Center API)

All Superinterfaces:

java.lang.Cloneable, IlrBasicModelElement, ilog.rules.teamserver.model.IlrCompositeObject, ilog.rules.commonbrm.model.IlrElement, IlrElementDetails, IlrElementHandle, IlrElementSummary, IlrModelElement, IlrPackageElement, IlrProjectElement, java.io.Serializable
```
public interface IlrRuleflow
extends IlrPackageElement
```
A representation of the model object 'Ruleflow'.

The following features are supported:
- Initial Actions
- Final Actions
- Diagram
- Body
- Tasks
- Scopes
- Imports
- Main Flow Task
- Tags
- Locale
See Also:
IlrBrmPackage.getRuleflow()

Method Summary

Methods
Modifier and Type	Method and Description
`java.util.List<IlrRuleflow>`	`getAllSubflows()` Gets the list of all subflows referenced by this ruleflow and its subflows.
`java.lang.String`	`getBody()` Returns the value of the 'Body' attribute.
`java.lang.String`	`getDiagram()` Deprecated. You should now get the ruleflow model through `ilog.rules.teamserver.brm.IlrRuleflow.getRFModel()` and introspect its content through the new ruleflow APIs.
`java.lang.String`	`getFinalActions()` Deprecated. You should now get the ruleflow model through `ilog.rules.teamserver.brm.IlrRuleflow.getRFModel()` and introspect its content through the new ruleflow APIs.
`java.util.List`	`getImports()` Returns the value of the 'Imports' attribute list.
`java.lang.String`	`getInitialActions()` Deprecated. You should now get the ruleflow model through `ilog.rules.teamserver.brm.IlrRuleflow.getRFModel()` and introspect its content through the new ruleflow APIs.
`java.lang.String`	`getLocale()` Returns the value of the 'Locale' attribute.
`java.util.List`	`getScopes()` Deprecated. You should now get the ruleflow model through `ilog.rules.teamserver.brm.IlrRuleflow.getRFModel()` and introspect its content through the new ruleflow APIs.
`java.util.List`	`getScopes(IlrElementVersion version)` Deprecated. You should now get the ruleflow model through `ilog.rules.teamserver.brm.IlrRuleflow.getRFModel()` and introspect its content through the new ruleflow APIs.
`java.util.List<IlrRuleflow>`	`getSubflows()` Gets the list of subflows referenced by this ruleflow.
`java.util.List`	`getTags()` Returns the value of the 'Tags' containment reference list.
`java.util.List`	`getTags(IlrElementVersion version)` Returns the value of the 'Tags' containment reference list for the given version.
`java.util.List`	`getTasks()` Deprecated. You should now get the ruleflow model through `ilog.rules.teamserver.brm.IlrRuleflow.getRFModel()` and introspect its content through the new ruleflow APIs.
`java.util.List`	`getTasks(IlrElementVersion version)` Deprecated. You should now get the ruleflow model through `ilog.rules.teamserver.brm.IlrRuleflow.getRFModel()` and introspect its content through the new ruleflow APIs.
`boolean`	`isMainFlowTask()` Returns the value of the 'Main Flow Task' attribute.

Methods inherited from interface ilog.rules.teamserver.brm.IlrPackageElement
getRulePackage

Methods inherited from interface ilog.rules.teamserver.brm.IlrProjectElement
getDocumentation, getGroup, getProject, getVersion

Methods inherited from interface ilog.rules.teamserver.brm.IlrModelElement
getName, getUuid

Methods inherited from interface ilog.rules.teamserver.brm.IlrBasicModelElement
getCreatedBy, getCreatedOn, getLastChangedBy, getLastChangedOn

Methods inherited from interface ilog.rules.teamserver.model.IlrElementDetails
cloneElement, getContainer, getRawValue, setRawValue, setRawValueNoCheck

Methods inherited from interface ilog.rules.teamserver.model.IlrElementHandle
eClass, equals, equals, getModelInfo, getSession, getType, getValue, getValue, hashCode, isNew, toIdString

Methods inherited from interface ilog.rules.commonbrm.model.IlrElement
getPropertyValue, getPropertyValue, isInstanceOf

- Method Detail
  - getInitialActions
```
java.lang.String getInitialActions()
```
    Deprecated. You should now get the ruleflow model through ilog.rules.teamserver.brm.IlrRuleflow.getRFModel() and introspect its content through the new ruleflow APIs.
    Returns the value of the 'Initial Actions' attribute.
    
    Initial actions can be specified for:
    - Start points
    - Rule tasks
    - Function tasks
    - Subflow tasks
    Initial actions are applied before a task is performed.
    Returns:
    the value of the 'Initial Actions' attribute.
    See Also:
    IlrBrmPackage.getRuleflow_InitialActions(), IlrRFBodyable.getBody(), ilog.rules.teamserver.brm.IlrRuleflow.getRFModel()
  - getFinalActions
```
java.lang.String getFinalActions()
```
    Deprecated. You should now get the ruleflow model through ilog.rules.teamserver.brm.IlrRuleflow.getRFModel() and introspect its content through the new ruleflow APIs.
    Returns the value of the 'Final Actions' attribute.
    
    Final actions can be specified for:
    - End points
    - Rule tasks
    - Function tasks
    - Subflow tasks
    Final actions are applied after a task is performed.
    Returns:
    the value of the 'Final Actions' attribute.
    See Also:
    IlrBrmPackage.getRuleflow_FinalActions(), IlrRFBodyable.getBody(), ilog.rules.teamserver.brm.IlrRuleflow.getRFModel()
  - getDiagram
```
java.lang.String getDiagram()
```
    Deprecated. You should now get the ruleflow model through ilog.rules.teamserver.brm.IlrRuleflow.getRFModel() and introspect its content through the new ruleflow APIs.
    
    Returns the value of the 'Diagram' attribute.
    
    Returns:
    the value of the 'Diagram' attribute.
    See Also:
    IlrBrmPackage.getRuleflow_Diagram(), ilog.rules.teamserver.brm.IlrRuleflow.getRFModel()
  - getBody
```
java.lang.String getBody()
```
    Returns the value of the 'Body' attribute.
    
    Returns:
    the value of the 'Body' attribute.
    See Also:
    IlrBrmPackage.getRuleflow_Body()
  - getTasks
```
java.util.List getTasks()
                        throws IlrObjectNotFoundException
```
    Deprecated. You should now get the ruleflow model through ilog.rules.teamserver.brm.IlrRuleflow.getRFModel() and introspect its content through the new ruleflow APIs.
    
    Returns the value of the 'Tasks' containment reference list.
    The list contents are of type IlrTask.
    
    Throws:
    
    IlrObjectNotFoundException
    
    Returns:
    the value of the 'Tasks' containment reference list.
    See Also:
    IlrBrmPackage.getRuleflow_Tasks(), ilog.rules.teamserver.brm.IlrRuleflow.getRFModel()
  - getTasks
```
java.util.List getTasks(IlrElementVersion version)
                        throws IlrObjectNotFoundException
```
    Deprecated. You should now get the ruleflow model through ilog.rules.teamserver.brm.IlrRuleflow.getRFModel() and introspect its content through the new ruleflow APIs.
    
    Returns the value of the 'Tasks' containment reference list for the given version. Allows to retrieve the value linked to a specific version. Useful when the working baseline is the current baseline.
    The list contents are of type IlrTask.
    
    Throws:
    
    IlrObjectNotFoundException
    Parameters:
    version - The version of the element.
    
    Returns:
    the value of the 'Tasks' containment reference list.
    See Also:
    IlrBrmPackage.getRuleflow_Tasks(), ilog.rules.teamserver.brm.IlrRuleflow.getRFModel()
  - getScopes
```
java.util.List getScopes()
                         throws IlrObjectNotFoundException
```
    Deprecated. You should now get the ruleflow model through ilog.rules.teamserver.brm.IlrRuleflow.getRFModel() and introspect its content through the new ruleflow APIs.
    
    Returns the value of the 'Scopes' containment reference list.
    The list contents are of type IlrScopeElement.
    
    Throws:
    
    IlrObjectNotFoundException
    
    Returns:
    the value of the 'Scopes' containment reference list.
    See Also:
    IlrBrmPackage.getRuleflow_Scopes(), ilog.rules.teamserver.brm.IlrRuleflow.getRFModel()
  - getScopes
```
java.util.List getScopes(IlrElementVersion version)
                         throws IlrObjectNotFoundException
```
    Deprecated. You should now get the ruleflow model through ilog.rules.teamserver.brm.IlrRuleflow.getRFModel() and introspect its content through the new ruleflow APIs.
    
    Returns the value of the 'Scopes' containment reference list for the given version. Allows to retrieve the value linked to a specific version. Useful when the working baseline is the current baseline.
    The list contents are of type IlrScopeElement.
    
    Throws:
    
    IlrObjectNotFoundException
    Parameters:
    version - The version of the element.
    
    Returns:
    the value of the 'Scopes' containment reference list.
    See Also:
    IlrBrmPackage.getRuleflow_Scopes(), ilog.rules.teamserver.brm.IlrRuleflow.getRFModel()
  - getImports
```
java.util.List getImports()
```
    Returns the value of the 'Imports' attribute list.
    The list contents are of type String.
    
    Returns:
    the value of the 'Imports' attribute list.
    See Also:
    IlrBrmPackage.getRuleflow_Imports()
  - isMainFlowTask
```
boolean isMainFlowTask()
```
    Returns the value of the 'Main Flow Task' attribute.
    
    Returns:
    the value of the 'Main Flow Task' attribute.
    See Also:
    IlrBrmPackage.getRuleflow_MainFlowTask()
  - getTags
```
java.util.List getTags()
                       throws IlrObjectNotFoundException
```
    Returns the value of the 'Tags' containment reference list.
    The list contents are of type IlrRuleflowTag.
    
    Throws:
    
    IlrObjectNotFoundException
    
    Returns:
    the value of the 'Tags' containment reference list.
    See Also:
    IlrBrmPackage.getRuleflow_Tags()
  - getTags
```
java.util.List getTags(IlrElementVersion version)
                       throws IlrObjectNotFoundException
```
    Returns the value of the 'Tags' containment reference list for the given version. Allows to retrieve the value linked to a specific version. Useful when the working baseline is the current baseline.
    The list contents are of type IlrRuleflowTag.
    
    Throws:
    
    IlrObjectNotFoundException
    Parameters:
    version - The version of the element.
    
    Returns:
    the value of the 'Tags' containment reference list.
    See Also:
    IlrBrmPackage.getRuleflow_Tags()
  - getLocale
```
java.lang.String getLocale()
```
    Returns the value of the 'Locale' attribute.
    
    Returns:
    the value of the 'Locale' attribute.
    See Also:
    IlrBrmPackage.getRuleflow_Locale()
  - getSubflows
```
java.util.List<IlrRuleflow> getSubflows()
                                        throws IlrObjectNotFoundException
```
    Gets the list of subflows referenced by this ruleflow.
    This method is not recursive, and only gets the subflows directly referenced in the ruleflow.
    
    Throws:
    
    IlrObjectNotFoundException - If this ruleflow cannot be found in the database.
    
    Returns:
    The list of subflows.
  - getAllSubflows
```
java.util.List<IlrRuleflow> getAllSubflows()
                                           throws IlrObjectNotFoundException
```
    Gets the list of all subflows referenced by this ruleflow and its subflows.
    This method is recursive.
    
    Throws:
    
    IlrObjectNotFoundException - If this ruleflow cannot be found in the database.
    
    Returns:
    The list of all subflows.

Methods inherited from interface ilog.rules.teamserver.brm.IlrPackageElement

Methods inherited from interface ilog.rules.teamserver.brm.IlrProjectElement

Methods inherited from interface ilog.rules.teamserver.brm.IlrModelElement

Methods inherited from interface ilog.rules.teamserver.brm.IlrBasicModelElement

Methods inherited from interface ilog.rules.teamserver.model.IlrElementDetails

Methods inherited from interface ilog.rules.teamserver.model.IlrElementHandle

Methods inherited from interface ilog.rules.commonbrm.model.IlrElement

getInitialActions

getFinalActions

getDiagram

getBody

getTasks

getTasks

getScopes

getScopes

getImports

isMainFlowTask

getTags

getTags

getLocale

getSubflows

getAllSubflows