public interface

WebTemplateAttribute

implements WebThresholdsContainer
com.microstrategy.web.objects.WebTemplateAttribute

Class Overview

The WebTemplateAttribute interface represents an attribute contained on a template. This object can be obtained from the WebTemplateUnit object which it is contained within.

Summary

Public Methods
abstract WebTransactableUnit findTransactableUnit(String formID)
Return a WebTransactableUnit without modifying the internal collection of transactable units
abstract WebObjectInfo getAttributeInfo()
Returns the WebObjectInfo object corresponding to the WebTemplateAttribute object which it is called on.
abstract int getAxisIndex()
Returns the index of the WebAxis which this template attribute is on.
abstract WebDerivedElements getDerivedElements()
abstract WebAttributeForms getForms()
Returns the WebAttributeForms object which is a collection of the forms to display for this template attribute.
abstract int getKey()
Returns the key of the attribute on the template.
abstract int getPosition()
Returns the position of the template attribute on its axis.
abstract int getThresholdCount()
abstract boolean getThresholdsEnabled()
abstract WebTransactableUnit getTransactableUnit(String formID)
abstract boolean hasDerivedElements(WebWorkingSet ws)
abstract boolean hasDerivedElements()
abstract boolean isDerived()
Specifies if this represents a derived attribute.
abstract void setShowThresholds(boolean show)
abstract void setThresholdCount(int count)
set The number of thresholds defined for this attribute.
abstract void setThresholdsEnabled(boolean enabled)
set The thresholds enabled prop.
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebThresholdsContainer

Public Methods

public abstract WebTransactableUnit findTransactableUnit (String formID)

Return a WebTransactableUnit without modifying the internal collection of transactable units

Parameters
formID String containing form GUID to retrieve unit of
Returns

public abstract WebObjectInfo getAttributeInfo ()

Returns the WebObjectInfo object corresponding to the WebTemplateAttribute object which it is called on.

Returns
  • The WebObjectInfo object which this template attribute refers to.

public abstract int getAxisIndex ()

Returns the index of the WebAxis which this template attribute is on.

Returns
  • The owner axis' index, from EnumDSSXMLAxisName.

public abstract WebDerivedElements getDerivedElements ()

public abstract WebAttributeForms getForms ()

Returns the WebAttributeForms object which is a collection of the forms to display for this template attribute.

Returns
  • The WebAttributeForms object which is a collection of the forms to display for this template attribute.

public abstract int getKey ()

Returns the key of the attribute on the template.

Returns
  • The key of the attribute.

public abstract int getPosition ()

Returns the position of the template attribute on its axis. This value is 1-based.

Returns
  • The position of the template attribute.

public abstract int getThresholdCount ()

Returns
  • The number of thresholds defined for this attribute.

public abstract boolean getThresholdsEnabled ()

public abstract WebTransactableUnit getTransactableUnit (String formID)

public abstract boolean hasDerivedElements (WebWorkingSet ws)

public abstract boolean hasDerivedElements ()

public abstract boolean isDerived ()

Specifies if this represents a derived attribute.

Returns
  • True if this is a derived attribute, false otherwise.

public abstract void setShowThresholds (boolean show)

Parameters
show whether to thresholds associated with this template metric

public abstract void setThresholdCount (int count)

set The number of thresholds defined for this attribute.

public abstract void setThresholdsEnabled (boolean enabled)

set The thresholds enabled prop.