Package com.uc4.api.objects

Class ProcessFlowGeneral

java.lang.Object
com.uc4.api.objects.ProcessFlowGeneral
All Implemented Interfaces:
HasAlias
public class ProcessFlowGeneral extends 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.

  • Constructor Details

    • ProcessFlowGeneral

      protected ProcessFlowGeneral(boolean isExternal)

    • ProcessFlowGeneral

      protected ProcessFlowGeneral(com.uc4.util.XMLDocument doc, Element task)

  • Method Details

    • store

      protected void store(com.uc4.util.XMLDocument doc, 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