Package com.uc4.api.objects

Class JobAttributes

  • public class JobAttributes
extends java.lang.Object
    This class represents the attributes of a job.

    • Constructor Detail

      • JobAttributes

        public JobAttributes​(com.uc4.util.XMLDocument doc,
                     boolean isMonitor)
        Constructs a JobAttributes using the specified XML document.
        Parameters:
        doc - XML document
        isMonitor - isMonitor defines whether attributes is of monitor or of an object.

    • Method Detail

      • getCodeName

        public UC4ObjectName getCodeName()
        Returns the name of the CodeTable.
        Returns:
        CodeTable

      • getHostType

        public java.lang.String getHostType()
        Returns the host typ of this job. For example for a windows job the return value is "WINDOWS".
        Returns:
        host type

      • getDeactivate

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

      • setDeactivate

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

      • getHost

        public UC4HostName getHost()
        Returns the name of the Agent for this job.
        Returns:
        host

      • getIntAccount

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

      • getConsumption

        public int getConsumption()
        Returns:
        The consumption value which is set for this Job.

      • setConsumption

        public void setConsumption​(int consumption)
        Sets the consumption value for this Job. The parameter consumption must be between 0 and 100000.
        Parameters:
        consumption - Consumption

      • getLogin

        public UC4ObjectName getLogin()
        Returns the name of the login object assigned to this job.
        Returns:
        login object

      • getStartType

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

      • setCodeName

        public void setCodeName​(UC4ObjectName codeTable)
        Sets the name of the CodeTable.
        Parameters:
        codeTable - CodeTable

      • setHost

        public void setHost​(UC4HostName host)
        Sets the Agent or AgentGroup for this Job.
        Parameters:
        host - Host

      • setIntAccount

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

      • setLogin

        public void setLogin​(UC4ObjectName loginObject)
        Sets the name of the login object.
        Parameters:
        loginObject - login object

      • setStartType

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

      • isAttributeDialog

        public boolean isAttributeDialog()
        Returns true if the attribut dialog should be displayed when the job is activated. The attribut dialog is sent as a READ form. The INotificationListener can be used to listen for READ forms.
        Returns:
        true if the attribut dialog should be displayed

      • isGenerateAtRuntime

        public boolean isGenerateAtRuntime()
        Returns true if the Job should not be generated at activation time but rather at runtime.
        Returns:
        true if the Generate at runtime check box is selected

      • setAttributeDialog

        public void setAttributeDialog​(boolean value)
        Sets or clears the attribut dialog check box. if value is true the check box is set.
        Parameters:
        value - boolean value indicating if the attribut dialog should be shown

      • maxParallel

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

      • setGenerateAtRuntime

        public void setGenerateAtRuntime​(boolean value)
        Sets or clears the Generate at runtime check box. if value is true the check box is set.
        Parameters:
        value - Generate at runtime

      • getPriority

        public int getPriority()
        Priority with which this Job should be executed in UC4. 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 Job should be executed in UC4. 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 job.
        Parameters:
        timezone - TimeZone

      • 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

      • store

        protected void store​(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element request)
        Stores the content of this job under the request element.
        Parameters:
        doc - XML document
        request - the newly created elements are children of the request element

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