| com.microstrategy.web.objects.WebTemplateAttributes |
The WebTemplateAttributes object represents the attributes collection which exists on a template. This object contains a collection of attributes, ordered by position. The WebTemplateAttributes object can be used to add, remove, and examine attributes on the template.
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract boolean |
canToggleThresholds()
Indicates whether thresholds display can be turned on/off
| ||||||||||
| abstract boolean |
containsKey(int key)
Returns whether the given key exists in the attributes collection.
| ||||||||||
| abstract Enumeration |
elements()
Returns a java.util.Enumeration, which can be used to iterate through the
WebTemplateAttribute objects in the collection in position ordering. | ||||||||||
| abstract WebTemplateAttribute |
get(int index)
Returns the
WebTemplateAttribute object with the given index. | ||||||||||
| abstract WebTemplateAttribute |
getItemById(String id)
Finds a template attribute based on attribute DSS ID.
| ||||||||||
| abstract WebTemplateAttribute |
getItemByKey(int key)
Returns the
WebTemplateAttribute object with the given key. | ||||||||||
| abstract boolean |
hasThresholds()
Indicates whether there are any thresholds defined on the underlying attributes
| ||||||||||
| abstract int |
indexOf(String id)
Returns an index of the template attribute for specified attribute DSS ID or -1 if it is not
found.
| ||||||||||
| abstract boolean |
isEmpty()
Returns true if the collection has no attributes in it.
| ||||||||||
| abstract boolean |
isThresholdsDisplayEnabled()
Indicates whether at least one of the thresholds defined on the underlying attributes
is enabled
| ||||||||||
| abstract void |
setShowThresholds(boolean show)
Set or clear all thresholds of all attributes.
| ||||||||||
| abstract int |
size()
Returns the number of
WebTemplateAttribute objects in the attributes collection. | ||||||||||
Indicates whether thresholds display can be turned on/off
| WebObjectsException | |
| WebObjectsException |
Returns whether the given key exists in the attributes collection.
| key | The key whose existence we're verifying. |
|---|
Returns a java.util.Enumeration, which can be used to iterate through the
WebTemplateAttribute objects in the collection in position ordering.
WebTemplateAttribute objects.
Returns the WebTemplateAttribute object with the given index.
| index | The index of the object to return from the collection. |
|---|
WebTemplateAttribute object which the given key refers to.| IndexOutOfBoundsException | Thrown if the index is outside the bounds of the collection. |
|---|
Finds a template attribute based on attribute DSS ID. Returns null if attribute not found.
| id | attribute DSS ID |
|---|
Returns the WebTemplateAttribute object with the given key.
| key | The key of the object to search for in the collection. |
|---|
WebTemplateAttribute object which the given key refers to.| IllegalArgumentException | Thrown if the key is not found in the attributes collection. |
|---|
Indicates whether there are any thresholds defined on the underlying attributes
Returns an index of the template attribute for specified attribute DSS ID or -1 if it is not found.
| id | attribute DSS ID |
|---|
Returns true if the collection has no attributes in it.
Indicates whether at least one of the thresholds defined on the underlying attributes is enabled
Set or clear all thresholds of all attributes. To see the changes in data, applyChanges()
need to be called to retrieve another instance, which will have the changed data.
| show | boolean to indicate whether to show or to hide all thresholds. |
|---|
Returns the number of WebTemplateAttribute objects in the attributes collection.