ProcessFlowGeneral (java-api 21.0.9 API)

java.lang.Object
- com.uc4.api.objects.ProcessFlowGeneral

All Implemented Interfaces:

HasAlias
```
public class ProcessFlowGeneral
extends java.lang.Object
implements HasAlias
```
This class can be used to access the "General" tab of a task in a ProcessFlow. An alias name and a time checkpoint can be specified here.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProcessFlowGeneral.DeploymentDependency
DeploymentDependency.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProcessFlowGeneral.DeploymentDependency` DeploymentDependency.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ProcessFlowGeneral(boolean isExternal)`
`protected`	`ProcessFlowGeneral(com.uc4.util.XMLDocument doc, org.w3c.dom.Element task)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProcessFlowGeneral`	`copy()` Creates a deep copy of this object
`UC4Alias`	`getAlias()` Returns the alias name of this task or `null` if no alias is set.
`int`	`getDaysAfterJobPlanActivation()` Returns the number of days as of JobPlan activation.
`ProcessFlowGeneral.DeploymentDependency`	`getDeploymentDependency()` Returns the dependency of the component process worflow.
`UC4ObjectName`	`getExecute()` Returns the name of the object that is to be started when the checkpoint has been exceeded.
`Time`	`getTime()` Returns the checkpoint time.
`UC4TimezoneName`	`getTimezone()` Returns the TimeZone that is to be used.
`boolean`	`isRequestParameterAtWFStart()` If this property is set and "Request task parameters" is selected as well, the container window is displayed immediately at the generation time of the workflow (and not at the point of time when the appropriate task would be ready to run within the workflow).
`boolean`	`isRequestTaskParameters()` If this property is set and the selected task has either a PromptSet or selected "Request task parameters" option on object definition level, the container window pops-up.
`boolean`	`isRollbackEnabled()` Returns `true` if rollback is enabled for this ProcessFlow task.
`boolean`	`isRunPerPatch()` Returns `true` if this task should run per patch in a deployment ProcessFlow.
`boolean`	`isTimeCheckpoint()` Returns `true` if time checkpoint is enabled for this JobPlanTask.
`void`	`setAlias(UC4Alias alias)` Sets the alias, use `null` to remove the alias.
`void`	`setDaysAfterJobPlanActivation(int daysAfterJobPlanActivation)` Sets the number of days as of JobPlan activation.
`void`	`setDeploymentDependency(ProcessFlowGeneral.DeploymentDependency deploymentDependency)` Sets the dependency of the component process workflow.
`void`	`setExecute(UC4ObjectName execute)` Sets the name of the object that is to be started when the checkpoint has been exceeded.
`void`	`setRequestParameterAtWFStart(boolean requestParameterAtWFStart)` If this property is set and "Request task parameters" is selected as well, the container window is displayed immediately at the generation time of the workflow (and not at the point of time when the appropriate task would be ready to run within the workflow).
`void`	`setRequestTaskParameters(boolean requestTaskParameters)` If this property is set and the selected task has either a PromptSet or selected "Request task parameters" option on object definition level, the container window pops-up.
`void`	`setRollbackEnabled(boolean rollbackEnabled)` Enables or disables rollback for this ProcessFlow task.
`void`	`setRunPerPatch(boolean runPerPatch)` Enables or disables the patch flag.
`void`	`setTime(Time time)` Sets the Checkpoint time.
`void`	`setTimeCheckpoint(boolean timeCheckpoint)` Enables or disables the time checkpoint for this JobPlanTask.
`void`	`setTimezone(UC4TimezoneName timezone)` Sets the TimeZone that is to be used.
`protected void`	`store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element task)`

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

- Constructor Detail
  - ProcessFlowGeneral
```
protected ProcessFlowGeneral(boolean isExternal)
```
  - ProcessFlowGeneral
```
protected ProcessFlowGeneral(com.uc4.util.XMLDocument doc,
                             org.w3c.dom.Element task)
```
- Method Detail
  - store
```
protected void store(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element task)
```
  - getAlias
```
public UC4Alias getAlias()
```
    Returns the alias name of this task or null if no alias is set.
    
    Specified by:
    
    getAlias in interface HasAlias
    
    Returns:
    
    Alias name or null
  - isRequestTaskParameters
```
public boolean isRequestTaskParameters()
```
    If this property is set and the selected task has either a PromptSet or selected "Request task parameters" option on object definition level, the container window pops-up.
    
    Returns:
    
    true if task parameter should be shown
  - setRequestTaskParameters
```
public void setRequestTaskParameters(boolean requestTaskParameters)
```
    If this property is set and the selected task has either a PromptSet or selected "Request task parameters" option on object definition level, the container window pops-up.
    
    Parameters:
    
    requestTaskParameters - true if task parameter should be shown
  - isRequestParameterAtWFStart
```
public boolean isRequestParameterAtWFStart()
```
    If this property is set and "Request task parameters" is selected as well, the container window is displayed immediately at the generation time of the workflow (and not at the point of time when the appropriate task would be ready to run within the workflow).
    
    Returns:
    
    true if the task parameters should be requested when the Workflow is generated, false if the task parameter should be requested at the time this step is executed.
  - setRequestParameterAtWFStart
```
public void setRequestParameterAtWFStart(boolean requestParameterAtWFStart)
```
    If this property is set and "Request task parameters" is selected as well, the container window is displayed immediately at the generation time of the workflow (and not at the point of time when the appropriate task would be ready to run within the workflow).
    
    Parameters:
    
    requestParameterAtWFStart - true if the task parameters should be requested when the Workflow is generated, false if the task parameter should be requested at the time this step is executed.
  - isRollbackEnabled
```
public boolean isRollbackEnabled()
```
    Returns true if rollback is enabled for this ProcessFlow task.
    
    Returns:
    
    Rollback enabled
  - setRollbackEnabled
```
public void setRollbackEnabled(boolean rollbackEnabled)
```
    Enables or disables rollback for this ProcessFlow task.
    
    Parameters:
    
    rollbackEnabled - Rollback option
  - isRunPerPatch
```
public boolean isRunPerPatch()
```
    Returns true if this task should run per patch in a deployment ProcessFlow.
    
    Returns:
    
    Run per Patch
  - setRunPerPatch
```
public void setRunPerPatch(boolean runPerPatch)
```
    Enables or disables the patch flag.
    
    Parameters:
    
    runPerPatch - true if this task should run per patch in a deployment ProcessFlow, false if this task is not a task for a patch in a deployment ProcessFlow
  - getDeploymentDependency
```
public ProcessFlowGeneral.DeploymentDependency getDeploymentDependency()
```
    Returns the dependency of the component process worflow.
    
    Returns:
    
    One of the DeploymentDependency defined in this class (NA, PARALLEL, SERIAL)
  - setDeploymentDependency
```
public void setDeploymentDependency(ProcessFlowGeneral.DeploymentDependency deploymentDependency)
```
    Sets the dependency of the component process workflow.
    
    Parameters:
    
    deploymentDependency - One of the DeploymentDependency defined in this class (NA, PARALLEL, SERIAL)
  - setAlias
```
public void setAlias(UC4Alias alias)
```
    Sets the alias, use null to remove the alias.
    
    Parameters:
    
    alias - Alias name or null
  - isTimeCheckpoint
```
public boolean isTimeCheckpoint()
```
    Returns true if time checkpoint is enabled for this JobPlanTask.
    
    Returns:
    
    True if a time checkpoint is enabled
  - setTimeCheckpoint
```
public void setTimeCheckpoint(boolean timeCheckpoint)
```
    Enables or disables the time checkpoint for this JobPlanTask.
    
    Parameters:
    
    timeCheckpoint - Boolean value to set the time checkpoint
  - setDaysAfterJobPlanActivation
```
public void setDaysAfterJobPlanActivation(int daysAfterJobPlanActivation)
```
    Sets the number of days as of JobPlan activation.
    Examples:
    - 0 days = the day of JobPlan activation
    - 2 days = two days after JobPlan activation
    Permitted values: 0 - 99
    Parameters:
    
    daysAfterJobPlanActivation - Number of days as of JobPlan activation
  - getTime
```
public Time getTime()
```
    Returns the checkpoint time.
    
    Returns:
    
    Checkpoint time
  - setTime
```
public void setTime(Time time)
```
    Sets the Checkpoint time.
    If the task could not be started before this time, the object specified in the "Execute" section will be activated.
    
    Parameters:
    
    time - Checkpoint time
  - getTimezone
```
public UC4TimezoneName getTimezone()
```
    Returns the TimeZone that is to be used.
    
    Returns:
    
    Used TimeZone
  - setTimezone
```
public void setTimezone(UC4TimezoneName timezone)
```
    Sets the TimeZone that is to be used.
    
    Parameters:
    
    timezone - TimeZone
  - getDaysAfterJobPlanActivation
```
public int getDaysAfterJobPlanActivation()
```
    Returns the number of days as of JobPlan activation.
    
    Returns:
    
    number of days as of JobPlan activation
  - getExecute
```
public UC4ObjectName getExecute()
```
    Returns the name of the object that is to be started when the checkpoint has been exceeded.
    
    Returns:
    
    Object name
  - setExecute
```
public void setExecute(UC4ObjectName execute)
```
    Sets the name of the object that is to be started when the checkpoint has been exceeded.
    
    Parameters:
    
    execute - Object name
  - copy
```
public ProcessFlowGeneral copy()
```
    Creates a deep copy of this object
    
    Returns:
    
    A copy of this object

Class ProcessFlowGeneral

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProcessFlowGeneral

ProcessFlowGeneral

Method Detail

store

getAlias

isRequestTaskParameters

setRequestTaskParameters

isRequestParameterAtWFStart

setRequestParameterAtWFStart

isRollbackEnabled

setRollbackEnabled

isRunPerPatch

setRunPerPatch

getDeploymentDependency

setDeploymentDependency

setAlias

isTimeCheckpoint

setTimeCheckpoint

setDaysAfterJobPlanActivation

getTime

setTime

getTimezone

setTimezone

getDaysAfterJobPlanActivation

getExecute

setExecute

copy