Package com.uc4.api.objects

Class JobPlan

    • Constructor Detail

      • JobPlan

        public JobPlan()

    • Method Detail

      • loadContent

        protected void loadContent​(com.uc4.util.XMLDocument doc,
                           ConnectionAttributes info)

      • values

        public ObjectValues values()
        Returns:
        Variables of this object

      • setTaskFactory

        protected void setTaskFactory​(WorkFlowTaskFactory taskFactory)
        Sub classes may call this method in order to provide their own sub class of JobPlanTask which may contain additional features.
        Parameters:
        taskFactory - Task Factory

      • rollback

        public Rollback rollback()
        This method provides access to the rollback tab of an executable object.
        Returns:
        Rollback settings

      • taskIterator

        public java.util.Iterator<JobPlanTask> taskIterator()
        Returns an iterator over JobPlanTask.
        Returns:
        iterator over JobPlanTask

      • taskSize

        public int taskSize()
        Returns the number of tasks in this JobPlan.
        Returns:
        Number of tasks

      • getFirstTaskByName

        public JobPlanTask getFirstTaskByName​(java.lang.String name)
        Returns the first task in the JobPlan monitor which has the specified object name.
        Parameters:
        name - Name of the UC4 object
        Returns:
        Task or null if not found

      • getTaskByUserDefinedID

        public JobPlanTask getTaskByUserDefinedID​(java.lang.String id)
        Returns a worfkflow task with the specified ID.
        Parameters:
        id - ID of the task
        Returns:
        Task or null if not found

      • addTask

        public void addTask​(JobPlanTask task)
        Adds a task to the JobPlan.
        Parameters:
        task - JobPlan task

      • removeTask

        public boolean removeTask​(JobPlanTask task)
        Removes the specified task from the JobPlan.
        Parameters:
        task - JobPlan task which should be removed
        Returns:
        True if the task was removed successfully

      • header

        public XHeader header()
        Returns the header data of this object. This is the information of the header tab in the dialog client.
        Returns:
        header

      • syncs

        public SyncList syncs()
        Returns a SyncList object which contains sync conditions of this object.
        Returns:
        sync conditions

      • runtime

        public Runtime runtime()
        Returns runtime information of this job. This corresponds to the "Runtime" tab in the dialog client.
        Returns:
        Runtime information

      • deployment

        public Deployment deployment()
        This method provides access to the deployment tab of a ProcessFlow.
        Returns:
        Deployment settings

      • getProcess

        public java.lang.String getProcess()
        Returns the content of the "Process" tab.
        Returns:
        JCL

      • setProcess

        public void setProcess​(java.lang.String script)
        Sets the content of the "Process" tab.
        Parameters:
        script - Script

      • attributes

        public JobPlanAttributes attributes()
        Returns attributes of this JobPlan.
        Returns:
        JobPlan attributes

      • getEndTask

        public JobPlanTask getEndTask()
        Returns the END-task of this JobPlan. A JobPlan always has an END task
        Returns:
        END task

      • getStartTask

        public JobPlanTask getStartTask()
        Returns the START-task of this JobPlan. A JobPlan always has an START task
        Returns:
        START task

      • storeContent

        protected void storeContent​(com.uc4.util.XMLDocument doc,
                            org.w3c.dom.Element objectElement,
                            ConnectionAttributes sessionInfo)

      • format

        public void format()
        Calculates the position of all tasks in this JobPlan.

      • validate

        public void validate()
              throws java.io.InvalidObjectException
        Description copied from class: UC4Object
        Validates the object. If the object is not valid an InvalidObjectException is thrown.
        Overrides:
        validate in class UC4Object
        Throws:
        java.io.InvalidObjectException - If the object is not valid

      • replaceTask

        public void replaceTask​(JobPlanTask oldTask,
                        JobPlanTask newTask)
        Replaces an existing JobPlanTask.
        Parameters:
        oldTask - JobPlanTask which should be replaced
        newTask - JobPlanTask which replaces the old task

      • closeJobPlanTasks

        public void closeJobPlanTasks​(TaskState when)
        Connects tasks with the START task if they have to predecessor. All tasks without successors are connected to the END task.
        Parameters:
        when - Status

      • clear

        public void clear()
        Removes all tasks.

      • isExecutable

        public boolean isExecutable()
        Description copied from class: UC4Object
        Returns true if this Object can be executed.
        Specified by:
        isExecutable in class UC4Object
        Returns:
        true if the Object can be executed, false if not.