Package com.uc4.api.objects

Class GroupAttributes

  • public class GroupAttributes
extends java.lang.Object
    JobGroup attributes.

    • Constructor Detail

      • GroupAttributes

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

    • Method Detail

      • store

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

      • getMaxParallel

        public int getMaxParallel()
        Returns the maximum number of executable objects which are allowed to run simultaneously in a Group. 0 to 999 tasks are allowed.
        Returns:
        Max. parallel tasks

      • setMaxParallel

        public void setMaxParallel​(int maxParallel)
        Specify the maximum number of executable objects which are allowed to run simultaneously in a Group. 0 to 999 tasks are allowed.
        Parameters:
        maxParallel - Integer between 0 and 999

      • 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 Automic object is executed.
        Parameters:
        queue - Name of the Queue Object

      • getChildrenQueue

        public UC4ObjectName getChildrenQueue()
        Returns the name of the Queue Object for children of this Group.
        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 Group.
        Parameters:
        childrenQueue - Name of the Queue (can be empty) or null for *OWN

      • 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

      • isGenerateAtRuntime

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

      • 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

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

      • 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