Summary:
Methods
| [Expand All]
public
interface
Instance
| com.microstrategy.web.objects.admin.monitors.Instance |
 Known Indirect Subclasses
|
Class Overview
This interface represents an Instance object, which is a collection of counters.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract Enumeration |
elements()
Returns a java.util.Enumeration containing the objects in this collection.
| ||||||||||
| abstract Counter |
get(int index)
Returns the
Counter at the given index within the collection. | ||||||||||
| abstract String |
getHelpMessage()
Returns the help message associated with the instance.
| ||||||||||
| abstract Counter |
getItemByName(String name)
Returns the
Counter in the collection with the given name. | ||||||||||
| abstract String |
getLocalizedHelpMessage(Locale locale)
Returns the localized help message associated with this instance.
| ||||||||||
| abstract String |
getLocalizedName(Locale locale)
Returns the localized name of the instance.
| ||||||||||
| abstract String |
getName()
Returns the name of the instance, if one exists.
| ||||||||||
| abstract Category |
getOwnerCategory()
Returns the
Category to which this counter belongs to. | ||||||||||
| abstract boolean |
isEmpty()
Returns whether the collection is empty.
| ||||||||||
| abstract int |
size()
Returns the size of the collection.
| ||||||||||
Public Methods
public abstract Enumeration elements ()
Returns a java.util.Enumeration containing the objects in this collection.
Returns
- An enumeration containing the objects in the collection.
public abstract Counter get (int index)
public abstract 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.
public abstract Counter getItemByName (String name)
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
| IllegalArgumentException | Thrown if no object with the given name doesn't exist in the collection. |
|---|
public abstract String getLocalizedHelpMessage (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
public abstract String getLocalizedName (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.
public abstract String getName ()
Returns the name of the instance, if one exists.
Returns
- The name of the instance.
public abstract Category getOwnerCategory ()
Returns the Category to which this counter belongs to.
Returns
- The category to which this counter belongs to.
public abstract boolean isEmpty ()
Returns whether the collection is empty.
Returns
- True if the collection is empty, false otherwise.
public abstract int size ()
Returns the size of the collection.
Returns
- The number of counters in the collection.