Package com.uc4.api.objects

Class Group

    • Constructor Detail

      • Group

        public Group()

    • Method Detail

      • loadContent

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

      • 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

      • getChildrenQueue

        @Deprecated
public UC4ObjectName getChildrenQueue()
        Deprecated.
        use attributes.getChildrenQueue of this group instead
        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

        @Deprecated
public void setChildrenQueue​(UC4ObjectName childrenQueue)
        Deprecated.
        use attributes.setChildrenQueue of this group instead
        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

      • getQueue

        @Deprecated
public UC4ObjectName getQueue()
        Deprecated.
        use attributes.getQueue of this group instead
        Returns the name of the Queue Object which is used to execute this Group.
        Returns:
        Name of the Queue

      • setQueue

        @Deprecated
public void setQueue​(UC4ObjectName queue)
        Deprecated.
        use attributes.setQueue of this group instead
        Sets the name of the Queue Object in which this Group should run.
        Parameters:
        queue - Name of the Queue

      • getTimezone

        @Deprecated
public UC4TimezoneName getTimezone()
        Deprecated.
        use attributes.getTimezone of this group instead
        Returns the TimeZone that is to be used.
        Returns:
        TimeZone

      • setTimezone

        @Deprecated
public void setTimezone​(UC4TimezoneName timezone)
        Deprecated.
        use attributes.setTimezone of this group instead
        Sets the TimeZone for this job.
        Parameters:
        timezone - TimeZone

      • isGenerateAtRuntime

        @Deprecated
public boolean isGenerateAtRuntime()
        Deprecated.
        use attributes.isGenerateAtRuntime of this group instead
        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

      • setGenerateAtRuntime

        @Deprecated
public void setGenerateAtRuntime​(boolean value)
        Deprecated.
        use attributes.setGenerateAtRuntime of this group instead
        Sets or clears the Generate at runtime check box. if value is true the check box is set.
        Parameters:
        value - Generate at runtime

      • getMaxParallel

        @Deprecated
public int getMaxParallel()
        Deprecated.
        use attributes.maxParallel of this group instead
        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

        @Deprecated
public void setMaxParallel​(int maxParallel)
        Deprecated.
        use attributes.maxParallel().setParallelTask of this group instead
        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

      • 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

      • 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 GroupAttributes attributes()
        Returns:
        "Attributes" tab of this group

      • 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

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