Package com.uc4.api.systemoverview

Class ClientListItem

  • public class ClientListItem
extends java.lang.Object
    This class represents one row in the client list of the system overview.

    • Constructor Summary

      Constructors 
      Constructor Description
      ClientListItem​(org.w3c.dom.Element row)
      Constructs a ClientListItem from a XML element.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getClient()
      Returns the number of the client.
      java.lang.String getId()
      ID of the client.
      java.lang.String getMibInfo()
      Returns MIB information of the client.
      java.lang.String getMibMonitor()
      Displays whether the client is subject to SNMP monitoring.
      int getNumberOfActivities()
      Number of tasks currently being executed.
      int getNumberOfObjects()
      Number of objects created in the client.
      int getNumberOfUsers()
      Number of users that are currently logged-on.
      int getPriority()
      Default value of the priority set for the client in the UC4 Variable UC_CLIENT_SETTINGS.
      int getTaskPriority()
      Default value of the priority set for the client in the UC4 Variable UC_CLIENT_SETTINGS.
      UC4TimezoneName getTimezone()
      Time zone valid in this client.
      java.lang.String getTitle()
      Title specified in the client object.
      boolean isClientActive()
      Returns true if the client is currently active.
      boolean isClientInDeletion()
      Returns true if the client is in deletion progress and client is not active.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ClientListItem

        public ClientListItem​(org.w3c.dom.Element row)
        Constructs a ClientListItem from a XML element.
        Parameters:
        row - Element

    • Method Detail

      • isClientInDeletion

        public boolean isClientInDeletion()
        Returns true if the client is in deletion progress and client is not active.
        Returns:
        is in deletion

      • isClientActive

        public boolean isClientActive()
        Returns true if the client is currently active.
        Returns:
        client state

      • getClient

        public int getClient()
        Returns the number of the client.
        Returns:
        client

      • getMibInfo

        public java.lang.String getMibInfo()
        Returns MIB information of the client.
        Returns:
        MIB Info

      • getMibMonitor

        public java.lang.String getMibMonitor()
        Displays whether the client is subject to SNMP monitoring.
        Returns:
        MIB Monitor

      • getPriority

        public int getPriority()
        Default value of the priority set for the client in the UC4 Variable UC_CLIENT_SETTINGS.
        Returns:
        Priority

      • getTaskPriority

        public int getTaskPriority()
        Default value of the priority set for the client in the UC4 Variable UC_CLIENT_SETTINGS.
        Returns:
        Task priority

      • getNumberOfActivities

        public int getNumberOfActivities()
        Number of tasks currently being executed.
        Returns:
        Number of tasks

      • getNumberOfObjects

        public int getNumberOfObjects()
        Number of objects created in the client.
        Returns:
        Number of objects

      • getNumberOfUsers

        public int getNumberOfUsers()
        Number of users that are currently logged-on.
        Returns:
        Number of users

      • getTimezone

        public UC4TimezoneName getTimezone()
        Time zone valid in this client.
        Returns:
        Time zone

      • getTitle

        public java.lang.String getTitle()
        Title specified in the client object.
        Returns:
        Title

      • getId

        public java.lang.String getId()
        ID of the client.
        Returns:
        ID

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object