ProcessFlowSettings (java-api 21.0.12 API)

java.lang.Object
- com.uc4.communication.ProcessFlowSettings

```
public class ProcessFlowSettings
extends java.lang.Object
```
This class represents the Process Flow settings. These settings can be found in the User Interface - Options - Settings - Process Flow

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProcessFlowSettings.AskForAlias` Open dialog box for alias input when a task is added to a process flow.
`static class`	`ProcessFlowSettings.ElseAction` Default Else action of tasks in a ProcessFlow.
`static class`	`ProcessFlowSettings.ExternalTaskStatus` Status for external tasks.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProcessFlowSettings.AskForAlias`	`getAskForAlias()` Returns if the dialog "Add task" should be displayed when you add ProcessFlow tasks using the drag and drop function.
`ProcessFlowSettings.ElseAction`	`getElseAction()` Returns the default else action when tasks are added to a Process Flow.
`UC4ObjectName`	`getElseExecute()` Returns the default name of the UC4 Object which should be executed as ELSE action when a task are added to a Process Flow.
`ProcessFlowSettings.ExternalTaskStatus`	`getStatusForExternalTasks()` Returns the default status for external tasks in a ProcessFlow.
`TaskState`	`getStatusForInternalTasks()` Returns the default status for tasks in a ProcessFlow.
`boolean`	`isTooltipCalendar()` Returns `true` if the calendar information sould be shown in the tooltip of a task in a Process Flow.
`boolean`	`isTooltipCheckpoint()` Returns `true` if the checkpoint information sould be shown in the tooltip of a task in a Process Flow.
`boolean`	`isTooltipConditions()` Returns `true` if the conditions information sould be shown in the tooltip of a task in a Process Flow.
`boolean`	`isTooltipDependencies()` Returns `true` if the dependency information sould be shown in the tooltip of a task in a Process Flow.
`boolean`	`isTooltipEarliest()` Returns `true` if the earliest information sould be shown in the tooltip of a task in a Process Flow.
`boolean`	`isTooltipExternalDependency()` Returns `true` if the external dependencies sould be shown in the tooltip of a task in a Process Flow.
`boolean`	`isTooltipGeneral()` "General" has the effect that the tooltip displays an additional area that includes the most important information such as object type, host name and the short forms of specified properties.
`boolean`	`isTooltipRuntime()` Returns `true` if the runtime information sould be shown in the tooltip of a task in a Process Flow.
`boolean`	`isTooltipThumbnail()` Thumbnail has the effect that the box for the ProcessFlow task is shown in tooltip if a particular zoom level has been reached.
`void`	`setAskForAlias(ProcessFlowSettings.AskForAlias askForAlias)` Determines whether the dialog "Add task" should be displayed when you add ProcessFlow tasks using the drag and drop function, and when.
`void`	`setElseAction(ProcessFlowSettings.ElseAction elseAction)` Sets the default else action when tasks are added to a Process Flow.
`void`	`setElseExecute(UC4ObjectName elseExecute)` Sets the default name of the UC4 Object which should be executed as ELSE action when a task are added to a Process Flow.
`void`	`setStatusForExternalTasks(ProcessFlowSettings.ExternalTaskStatus statusForExternalTasks)` Sets the default status for external tasks in a ProcessFlow.
`void`	`setStatusForInternalTasks(TaskState statusForInternalTasks)` Sets the default status for tasks in a ProcessFlow.
`void`	`setTooltipCalendar(boolean tooltipCalendar)` Defines if calendar information sould be shown in the tooltip of a task in a Process Flow.
`void`	`setTooltipCheckpoint(boolean tooltipCheckpoint)` Defines if checkpoint information sould be shown in the tooltip of a task in a Process Flow.
`void`	`setTooltipConditions(boolean tooltipConditions)` Defines if condition information sould be shown in the tooltip of a task in a Process Flow.
`void`	`setTooltipDependencies(boolean tooltipDependencies)` Defines if dependency information sould be shown in the tooltip of a task in a Process Flow.
`void`	`setTooltipEarliest(boolean tooltipEarliest)` Defines if earliest information sould be shown in the tooltip of a task in a Process Flow.
`void`	`setTooltipExternalDependency(boolean tooltipExternalDependency)` Defines if external dependencies sould be shown in the tooltip of a task in a Process Flow.
`void`	`setTooltipGeneral(boolean tooltipGeneral)` "General" has the effect that the tooltip displays an additional area that includes the most important information such as object type, host name and the short forms of specified properties.
`void`	`setTooltipRuntime(boolean tooltipRuntime)` Defines if runtime information sould be shown in the tooltip of a task in a Process Flow.
`void`	`setTooltipThumbnail(boolean tooltipThumbnail)` Thumbnail has the effect that the box for the ProcessFlow task is shown in tooltip if a particular zoom level has been reached.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getStatusForInternalTasks
```
public TaskState getStatusForInternalTasks()
```
    Returns the default status for tasks in a ProcessFlow.
    
    Returns:
    
    Default status or null if not set
  - setStatusForInternalTasks
```
public void setStatusForInternalTasks(TaskState statusForInternalTasks)
```
    Sets the default status for tasks in a ProcessFlow.
    
    Parameters:
    
    statusForInternalTasks - Default status
  - getStatusForExternalTasks
```
public ProcessFlowSettings.ExternalTaskStatus getStatusForExternalTasks()
```
    Returns the default status for external tasks in a ProcessFlow.
    
    Returns:
    
    Default status
  - setStatusForExternalTasks
```
public void setStatusForExternalTasks(ProcessFlowSettings.ExternalTaskStatus statusForExternalTasks)
```
    Sets the default status for external tasks in a ProcessFlow.
    
    Parameters:
    
    statusForExternalTasks - Default status or null if no status should be set
  - getAskForAlias
```
public ProcessFlowSettings.AskForAlias getAskForAlias()
```
    Returns if the dialog "Add task" should be displayed when you add ProcessFlow tasks using the drag and drop function.
    Possible return values are:
    - AskForAlias.ALWAYS - The dialog always displays if objects are dragged and dropped to a ProcessFlow.
    - AskForAlias.DUPLICATE_ONLY - The dialog only opens if the object is already available in the ProcessFlow as a task. Only the object name is checked, not the alias name.
    - AskForAlias.NEVER (default) - The dialog does not open if the drag and drop function is used.
    Returns:
    
    Open dialog box for alias input
  - setAskForAlias
```
public void setAskForAlias(ProcessFlowSettings.AskForAlias askForAlias)
```
    Determines whether the dialog "Add task" should be displayed when you add ProcessFlow tasks using the drag and drop function, and when.
    - AskForAlias.ALWAYS - The dialog always displays if objects are dragged and dropped to a ProcessFlow.
    - AskForAlias.DUPLICATE_ONLY - The dialog only opens if the object is already available in the ProcessFlow as a task. Only the object name is checked, not the alias name.
    - AskForAlias.NEVER (default) - The dialog does not open if the drag and drop function is used.
    Parameters:
    
    askForAlias - Open dialog box for alias input
  - getElseAction
```
public ProcessFlowSettings.ElseAction getElseAction()
```
    Returns the default else action when tasks are added to a Process Flow.
    
    Returns:
    
    Default else action
  - setElseAction
```
public void setElseAction(ProcessFlowSettings.ElseAction elseAction)
```
    Sets the default else action when tasks are added to a Process Flow.
    
    Parameters:
    
    elseAction - Default else action
  - getElseExecute
```
public UC4ObjectName getElseExecute()
```
    Returns the default name of the UC4 Object which should be executed as ELSE action when a task are added to a Process Flow.
    
    Returns:
    
    Name of the UC4 Object
  - setElseExecute
```
public void setElseExecute(UC4ObjectName elseExecute)
```
    Sets the default name of the UC4 Object which should be executed as ELSE action when a task are added to a Process Flow.
    
    Parameters:
    
    elseExecute - Name of the UC4 Object
  - isTooltipThumbnail
```
public boolean isTooltipThumbnail()
```
    Thumbnail has the effect that the box for the ProcessFlow task is shown in tooltip if a particular zoom level has been reached. The tooltip contains a picture of the tooltip box if the ProcessFlow view has been reduced to an extent that the box content could not easily be read anymore.
    
    Returns:
    
    true if the TooltipThumbnail option is set, false otherwise
  - setTooltipThumbnail
```
public void setTooltipThumbnail(boolean tooltipThumbnail)
```
    Thumbnail has the effect that the box for the ProcessFlow task is shown in tooltip if a particular zoom level has been reached. The tooltip contains a picture of the tooltip box if the ProcessFlow view has been reduced to an extent that the box content could not easily be read anymore.
    
    Parameters:
    
    tooltipThumbnail - Set thumbnail option
  - isTooltipGeneral
```
public boolean isTooltipGeneral()
```
    "General" has the effect that the tooltip displays an additional area that includes the most important information such as object type, host name and the short forms of specified properties.
    
    Returns:
    
    true if the TooltipGeneral option is set, false otherwise
  - setTooltipGeneral
```
public void setTooltipGeneral(boolean tooltipGeneral)
```
    "General" has the effect that the tooltip displays an additional area that includes the most important information such as object type, host name and the short forms of specified properties.
    
    Parameters:
    
    tooltipGeneral - Set TooltipGeneral option
  - isTooltipExternalDependency
```
public boolean isTooltipExternalDependency()
```
    Returns true if the external dependencies sould be shown in the tooltip of a task in a Process Flow.
    
    Returns:
    
    Show external dependencies
  - setTooltipExternalDependency
```
public void setTooltipExternalDependency(boolean tooltipExternalDependency)
```
    Defines if external dependencies sould be shown in the tooltip of a task in a Process Flow.
    
    Parameters:
    
    tooltipExternalDependency - Show external dependencies
  - isTooltipCheckpoint
```
public boolean isTooltipCheckpoint()
```
    Returns true if the checkpoint information sould be shown in the tooltip of a task in a Process Flow.
    
    Returns:
    
    Show checkpoint information
  - setTooltipCheckpoint
```
public void setTooltipCheckpoint(boolean tooltipCheckpoint)
```
    Defines if checkpoint information sould be shown in the tooltip of a task in a Process Flow.
    
    Parameters:
    
    tooltipCheckpoint - Show checkpoint information
  - isTooltipEarliest
```
public boolean isTooltipEarliest()
```
    Returns true if the earliest information sould be shown in the tooltip of a task in a Process Flow.
    
    Returns:
    
    Show earliest information
  - setTooltipEarliest
```
public void setTooltipEarliest(boolean tooltipEarliest)
```
    Defines if earliest information sould be shown in the tooltip of a task in a Process Flow.
    
    Parameters:
    
    tooltipEarliest - Show earliest information
  - isTooltipDependencies
```
public boolean isTooltipDependencies()
```
    Returns true if the dependency information sould be shown in the tooltip of a task in a Process Flow.
    
    Returns:
    
    Show dependency information
  - setTooltipDependencies
```
public void setTooltipDependencies(boolean tooltipDependencies)
```
    Defines if dependency information sould be shown in the tooltip of a task in a Process Flow.
    
    Parameters:
    
    tooltipDependencies - Show dependency information
  - isTooltipCalendar
```
public boolean isTooltipCalendar()
```
    Returns true if the calendar information sould be shown in the tooltip of a task in a Process Flow.
    
    Returns:
    
    Show calendar information
  - setTooltipCalendar
```
public void setTooltipCalendar(boolean tooltipCalendar)
```
    Defines if calendar information sould be shown in the tooltip of a task in a Process Flow.
    
    Parameters:
    
    tooltipCalendar - Show calendar information
  - isTooltipRuntime
```
public boolean isTooltipRuntime()
```
    Returns true if the runtime information sould be shown in the tooltip of a task in a Process Flow.
    
    Returns:
    
    Show runtime information
  - setTooltipRuntime
```
public void setTooltipRuntime(boolean tooltipRuntime)
```
    Defines if runtime information sould be shown in the tooltip of a task in a Process Flow.
    
    Parameters:
    
    tooltipRuntime - Show runtime information
  - isTooltipConditions
```
public boolean isTooltipConditions()
```
    Returns true if the conditions information sould be shown in the tooltip of a task in a Process Flow.
    
    Returns:
    
    Show condition information
  - setTooltipConditions
```
public void setTooltipConditions(boolean tooltipConditions)
```
    Defines if condition information sould be shown in the tooltip of a task in a Process Flow.
    
    Parameters:
    
    tooltipConditions - Show condition information

Class ProcessFlowSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getStatusForInternalTasks

setStatusForInternalTasks

getStatusForExternalTasks

setStatusForExternalTasks

getAskForAlias

setAskForAlias

getElseAction

setElseAction

getElseExecute

setElseExecute

isTooltipThumbnail

setTooltipThumbnail

isTooltipGeneral

setTooltipGeneral

isTooltipExternalDependency

setTooltipExternalDependency

isTooltipCheckpoint

setTooltipCheckpoint

isTooltipEarliest

setTooltipEarliest

isTooltipDependencies

setTooltipDependencies

isTooltipCalendar

setTooltipCalendar

isTooltipRuntime

setTooltipRuntime

isTooltipConditions

setTooltipConditions