Package com.uc4.communication.requests

Class GroupMonitor.Task

  • Enclosing class:
    GroupMonitor
    public static class GroupMonitor.Task
extends java.lang.Object
    This class represents a task in the Group monitor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getAlias()
      In contrast to getName this method returns always the alias if used.
      java.lang.String getName()
      Returns the name of the object or an alias if used.
      java.lang.String getObjectName()
      In contrast to the getName this method returns always the object name.
      java.lang.String getObjectType()
      Returns the type of the Object.
      java.lang.String getPlatform()
      Returns the platform of the object or an empty String if a platform is not defined for the object.
      int getPriority()
      Return the priority of the task.
      int getRunID()
      Returns the RunID of the task in the monitor or 0 if the task has not been executed.
      DateTime getStartTime()
      Return the start time of the task.
      java.lang.String getStateIcon()
      Returns a description of the used icon for the specific task status.
      java.lang.String getStatus()
      Returns the status of this task as String which is independent on the logon language.
      int getStatusCode()
      Returns the status of the task as integer.
      java.lang.String getStatusText()
      Returns a description of the status.
      java.lang.String getUser()
      Return the user of the task.
      boolean isRollback()
      Return that the task can be rollback or not.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • isRollback

        public boolean isRollback()
        Return that the task can be rollback or not.
        Returns:
        rollback

      • getUser

        public java.lang.String getUser()
        Return the user of the task.
        Returns:
        user

      • getPriority

        public int getPriority()
        Return the priority of the task.
        Returns:
        Priority

      • getStartTime

        public DateTime getStartTime()
        Return the start time of the task.
        Returns:
        Time for task start in hours and minutes.

      • getRunID

        public int getRunID()
        Returns the RunID of the task in the monitor or 0 if the task has not been executed.
        Returns:
        RunID of the task or zero

      • getObjectType

        public java.lang.String getObjectType()
        Returns the type of the Object.
        Returns:
        Object type

      • getName

        public java.lang.String getName()
        Returns the name of the object or an alias if used. Use getObjectName and getAlias if you want exclusive information.
        Returns:
        name of object or alias.

      • getStatusText

        public java.lang.String getStatusText()
        Returns a description of the status. This return value depends on the logon language.
        Returns:
        description for task status. Possible return values are described in the status: AbstractTask.getStatusCode()

      • getStatusCode

        public final int getStatusCode()
        Returns the status of the task as integer.
        Returns:
        Status code or -1 in case of an error

      • getPlatform

        public java.lang.String getPlatform()
        Returns the platform of the object or an empty String if a platform is not defined for the object.
        Returns:
        Platform or an empty String

      • getStatus

        public java.lang.String getStatus()
        Returns the status of this task as String which is independent on the logon language.
        Returns:
        status, possible return values are described in the status table: AbstractTask.getStatusCode()

      • getStateIcon

        public java.lang.String getStateIcon()
        Returns a description of the used icon for the specific task status.
        Returns:
        description of the state icon

      • getAlias

        public java.lang.String getAlias()
        In contrast to getName this method returns always the alias if used.
        Returns:
        the alias as String or empty String no alias is used.

      • getObjectName

        public java.lang.String getObjectName()
        In contrast to the getName this method returns always the object name.
        Returns:
        the name of the object.