Package com.uc4.api.objects

Class Job

    • Constructor Detail

      • Job

        public Job()

    • Method Detail

      • loadContent

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

      • storeContent

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

      • rollback

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

      • ocvValues

        public OCVPanel ocvValues()
        This method provides access to the RA Job values. If this Job is not a RA Job the return value is null.
        Returns:
        Values or null if this Job is not an RA Job.

      • outputFiles

        public OutputFiles outputFiles()
        This method provides access to the registered output files of this Job definition.
        Returns:
        Output tab of the Job

      • getRAJobType

        public java.lang.String getRAJobType()
        Returns the Rapid Automation Job type or null if this is not an RA Job.
        Returns:
        RA Job type, for example "FTPAGENT"

      • getRASubJobType

        public java.lang.String getRASubJobType()
        Returns the Rapid Automation Sub Job type or null if this is not an RA Job.
        Returns:
        RA Sub Job type, for example "FTPFILETRANSFERJOB"

      • values

        public ObjectValues values()
        Returns:
        Variables of this object

      • syncs

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

      • outputScan

        public OutputScan outputScan()
        Returns an OutputScan instance which represents the "Output Scan" tab of an Job.
        Returns:
        Output Scan

      • 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

      • attributes

        public JobAttributes attributes()
        Returns the generic attributes of this job. The returned object contains all information of the attributes tab.
        Returns:
        Job attributes

      • hostAttributes

        public IHostAttributes hostAttributes()
        Returns host specific attributes. The return value is class that implements the IHostAttributes interface.
        Returns:
        host attributes

      • runtime

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

      • 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

      • setPreProcess

        public void setPreProcess​(java.lang.String preScript)
        Sets the content of the Pre Process tab. Contrary to the "Process" tab, the processing commands here are still processed within the header.
        Parameters:
        preScript - Pre Script

      • getPreProcess

        public java.lang.String getPreProcess()
        Returns the content of the Pre Process tab.
        Returns:
        preScript Pre Script

      • setPostProcess

        public void setPostProcess​(java.lang.String postScript)
        Sets the content of the Post Process tab. The script commands stored in this tab are processed after the Job has ended.
        Parameters:
        postScript - Post script

      • getPostProcess

        public java.lang.String getPostProcess()
        Returns the content of the Post Process tab.
        Returns:
        Post script

      • getChildPostProcess

        @Deprecated
public com.uc4.api.objects.ChildPostProcess getChildPostProcess()
        Deprecated.
        Will be removed in future version. Use getChildPostProcessScript() instead.
        Returns the content of the Child Post-Process tab.
        Returns:
        Child Post script

      • getChildPostProcessScript

        public java.lang.String getChildPostProcessScript()
        Returns the content of the Child Post-Process Script.
        Returns:
        String Child Post script

      • setChildPostProcess

        @Deprecated
public void setChildPostProcess​(com.uc4.api.objects.ChildPostProcess childPostProcess)
        Deprecated.
        Will be removed in future version. Use setChildPostProcessScript(String) instead.
        Sets the content of the Child Post-Process tab.
        • The script is processed for each individual child process.
        • The script is processed immediately after the child process finishes.

        Calling this method is only allowed for SAP and PS Jobs. If the Job type is not SAP or PS an IllegalStateException is thrown.

        Parameters:
        childPostProcess - Child Post script

      • setChildPostProcessScript

        public void setChildPostProcessScript​(java.lang.String childPostProcessScript)
        Sets the content of the Child Post-Process Script.
        • The script is set for child process.
        • The script is processed immediately after the child process finishes.

        Calling this method is only allowed for SAP and PS Jobs. If the Job type is not SAP or PS an IllegalStateException is thrown.

        Parameters:
        childPostProcessScript - child post process script

      • 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.