Package com.microstrategy.web.objects.admin.monitors

Interface Instance

  • All Known Implementing Classes:
    AbstractInstance
    public interface Instance
    This interface represents an Instance object, which is a collection of counters.
    Since:
    MicroStrategy Web 7.5.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Enumeration elements()
      Returns a java.util.Enumeration containing the objects in this collection.
      Counter get​(int index)
      Returns the Counter at the given index within the collection.
      java.lang.String getHelpMessage()
      Returns the help message associated with the instance.
      Counter getItemByName​(java.lang.String name)
      Returns the Counter in the collection with the given name.
      java.lang.String getLocalizedHelpMessage​(java.util.Locale locale)
      Returns the localized help message associated with this instance.
      java.lang.String getLocalizedName​(java.util.Locale locale)
      Returns the localized name of the instance.
      java.lang.String getName()
      Returns the name of the instance, if one exists.
      Category getOwnerCategory()
      Returns the Category to which this counter belongs to.
      boolean isEmpty()
      Returns whether the collection is empty.
      int size()
      Returns the size of the collection.

    • Method Detail

      • getName

        java.lang.String getName()
        Returns the name of the instance, if one exists.
        Returns:
        The name of the instance.

      • getLocalizedName

        java.lang.String getLocalizedName​(java.util.Locale locale)
        Returns the localized name of the instance.
        Parameters:
        locale - Locale The locale that the name to be localized to.
        Returns:
        String The localized name of the instance.
        Since:
        MicroStrategy Web 8.0.0

      • get

        Counter get​(int index)
     throws java.lang.IndexOutOfBoundsException
        Returns the Counter at the given index within the collection.
        Parameters:
        index - The index of the object to retrieve.
        Returns:
        The Counter object at the given index.
        Throws:
        java.lang.IndexOutOfBoundsException - Thrown if the index does not exist in the collection.

      • getItemByName

        Counter getItemByName​(java.lang.String name)
               throws java.lang.IllegalArgumentException
        Returns the Counter in the collection with the given name.
        Parameters:
        name - The name of the counter to return. Note: this is the name, not the localized name of the counter.
        Returns:
        The counter in the collection with the given name.
        Throws:
        java.lang.IllegalArgumentException - Thrown if no object with the given name doesn't exist in the collection.

      • size

        int size()
        Returns the size of the collection.
        Returns:
        The number of counters in the collection.

      • isEmpty

        boolean isEmpty()
        Returns whether the collection is empty.
        Returns:
        True if the collection is empty, false otherwise.

      • elements

        java.util.Enumeration elements()
        Returns a java.util.Enumeration containing the objects in this collection.
        Returns:
        An enumeration containing the objects in the collection.

      • getHelpMessage

        java.lang.String getHelpMessage()
        Returns the help message associated with the instance. The help string is an optional string which describes the instance.
        Returns:
        The help message associated with the instance.

      • getLocalizedHelpMessage

        java.lang.String getLocalizedHelpMessage​(java.util.Locale locale)
        Returns the localized help message associated with this instance.
        Parameters:
        locale - Locale The locale that the help message to localized to.
        Returns:
        String
        Since:
        MicroStrategy Web 8.0.0

      • getOwnerCategory

        Category getOwnerCategory()
        Returns the Category to which this counter belongs to.
        Returns:
        The category to which this counter belongs to.