Package com.uc4.api.objects

Class JobPlanAttributes

  • public class JobPlanAttributes
extends java.lang.Object
    This class repesents JobPlan attributes.

    • Constructor Detail

      • JobPlanAttributes

        protected JobPlanAttributes​(com.uc4.util.XMLDocument doc)

    • Method Detail

      • store

        protected void store​(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element request)

      • isReuseAgentGroups

        public boolean isReuseAgentGroups()
        Re-using AgentGroup calculation.
        Returns:
        Returns true if ProcessFlow tasks of the same AgentGroup should use the same hosts.

      • setReuseAgentGroups

        public void setReuseAgentGroups​(boolean reuseAgentGroups)
        Sets the flag for re-using AgentGroup calculation.
        Parameters:
        reuseAgentGroups - true if ProcessFlow tasks of the same AgentGroup should use the same hosts

      • isPassPriority

        public boolean isPassPriority()
        Pass priority to WF children
        Returns:
        Returns true if the WF priority should be passed on to the children tasks

      • setPassPriority

        public void setPassPriority​(boolean passPriority)
        Parameters:
        passPriority - Is true if the WF priority should be passed on to the children tasks

      • getChildrenQueue

        public UC4ObjectName getChildrenQueue()
        Returns the name of the Queue Object for children of this ProcessFlow.
        Returns:
        Name of the Queue or null if *OWN has been set.

      • setChildrenQueue

        public void setChildrenQueue​(UC4ObjectName childrenQueue)
        Sets the name of the Queue Object for children of this ProcessFlow.
        Parameters:
        childrenQueue - Name of the Queue (can be empty) or null for *OWN

      • getQueue

        public UC4ObjectName getQueue()
        Returns the Queue Object.
        Returns:
        Name of the Queue Object

      • setQueue

        public void setQueue​(UC4ObjectName queue)
        Sets the Queue that will be used when this object is executed.
        Parameters:
        queue - Name of the Queue Object

      • getStartType

        public UC4ObjectName getStartType()
        Returns the start type of this JobPlan.
        Returns:
        Start type

      • setStartType

        public void setStartType​(UC4ObjectName startType)
        Sets the start type of this JobPlan.
        Parameters:
        startType - Start type

      • getIntAccount

        public java.lang.String getIntAccount()
        Returns the internal account assigned to this JobPlan.
        Returns:
        Internal account

      • getDeactivate

        public DeactivateCondition getDeactivate()
        Returns the deactivate condition for this JobPlan.
        Returns:
        Deactivate condition

      • setDeactivate

        public void setDeactivate​(DeactivateCondition deactivate)
        Sets the deactivate condition for this JobPlan.
        Parameters:
        deactivate - Deactivate condition

      • setIntAccount

        public void setIntAccount​(java.lang.String intAccount)
        Sets the internal account, max. 20 characters.
        Parameters:
        intAccount - internal account

      • isGenerateAtRuntime

        public boolean isGenerateAtRuntime()
        Returns true if this JobPlan should not be generated at activation time but rather at runtime.
        Returns:
        True if "Generate at runtime" is selected

      • setGenerateAtRuntime

        public void setGenerateAtRuntime​(boolean generateAtRuntime)
        Sets if this JobPlan should be generated at runtime.
        Parameters:
        generateAtRuntime - If set to true the object is generated at runtime

      • maxParallel

        public MaxParallel maxParallel()
        Returns settings for parallel tasks.
        Returns:
        parallel task settings

      • getPriority

        public int getPriority()
        Priority with which this Workflow should be executed in the Automation Engine. Permitted values: 0 to 255
        Default: 0
        1 stands for highest, 255 for lowest priority. If 0 is chosen, the priority defined in the UC_CLIENT_SETTINGS variables with TASK_PRIORITY for local clients is used. If no default priority is set or if no variable is present in the local clients, then 200 is assigned as the valid priority.
        Returns:
        priority

      • setPriority

        public void setPriority​(int priority)
        Priority with which this Workflow should be executed in the Automation Engine. Permitted values: 0 to 255
        Default: 0
        1 stands for highest, 255 for lowest priority. If 0 is chosen, the priority defined in the UC_CLIENT_SETTINGS variables with TASK_PRIORITY for local clients is used. If no default priority is set or if no variable is present in the local clients, then 200 is assigned as the valid priority.
        Parameters:
        priority - Priority

      • getTimezone

        public UC4TimezoneName getTimezone()
        Returns the TimeZone that is to be used.
        Returns:
        TimeZone

      • setTimezone

        public void setTimezone​(UC4TimezoneName timezone)
        Sets the TimeZone for this JobPlan.
        Parameters:
        timezone - TimeZone

      • getOkStateForTasks

        public TaskState getOkStateForTasks()
        Returns the end status that is expected for the subordinated tasks of the JobPlan.
        Returns:
        Expected end status

      • setOkStateForTasks

        public void setOkStateForTasks​(TaskState state)
        Sets the end status that is expected for the subordinated tasks of the JobPlan.
        Parameters:
        state - Expected end status

      • getOkStateExecute

        public UC4ObjectName getOkStateExecute()
        Returns the object that is executed when a task does not have the expected end status.
        Returns:
        Name of the object which should be executed

      • setOkStateExecute

        public void setOkStateExecute​(UC4ObjectName okStateExecute)
        Sets the object that is executed when a task does not have the expected end status.
        Parameters:
        okStateExecute - Name of the object which should be executed

      • getExtendedReports

        public ExtendedReports getExtendedReports()
        Returns the setting for extended reports.
        Returns:
        Extended reports.

      • setExtendedReports

        public void setExtendedReports​(ExtendedReports extendedReports)
        Sets the option for extended reports.
        Parameters:
        extendedReports - Extended reports.