Package com.microstrategy.web.objects
Interface WebTemplateAttribute
-
- All Superinterfaces:
WebThresholdsContainer
public interface WebTemplateAttribute extends WebThresholdsContainer
The WebTemplateAttribute interface represents an attribute contained on a template. This object can be obtained from theWebTemplateUnit
object which it is contained within.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebTransactableUnit
findTransactableUnit(java.lang.String formID)
Return aWebTransactableUnit
without modifying the internal collection of transactable unitsWebObjectInfo
getAttributeInfo()
Returns theWebObjectInfo
object corresponding to the WebTemplateAttribute object which it is called on.int
getAxisIndex()
Returns the index of theWebAxis
which this template attribute is on.WebDerivedElements
getDerivedElements()
WebAttributeForms
getForms()
Returns theWebAttributeForms
object which is a collection of the forms to display for this template attribute.int
getKey()
Returns the key of the attribute on the template.int
getPosition()
Returns the position of the template attribute on its axis.int
getThresholdCount()
boolean
getThresholdsEnabled()
WebTransactableUnit
getTransactableUnit(java.lang.String formID)
boolean
hasDerivedElements()
boolean
hasDerivedElements(WebWorkingSet ws)
boolean
isDerived()
Specifies if this represents a derived attribute.void
setShowThresholds(boolean show)
void
setThresholdCount(int count)
set The number of thresholds defined for this attribute.void
setThresholdsEnabled(boolean enabled)
set The thresholds enabled prop.-
Methods inherited from interface com.microstrategy.web.objects.WebThresholdsContainer
getFormat, getID, getName, getObjectType, getThresholds, getTransactions, getType, initElementSource
-
-
-
-
Method Detail
-
getAxisIndex
int getAxisIndex()
Returns the index of theWebAxis
which this template attribute is on.- Returns:
- The owner axis' index, from
EnumDSSXMLAxisName
.
-
getPosition
int getPosition()
Returns the position of the template attribute on its axis. This value is 1-based.- Returns:
- The position of the template attribute.
-
getAttributeInfo
WebObjectInfo getAttributeInfo()
Returns theWebObjectInfo
object corresponding to the WebTemplateAttribute object which it is called on.- Returns:
- The
WebObjectInfo
object which this template attribute refers to.
-
getForms
WebAttributeForms getForms()
Returns theWebAttributeForms
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.
-
getDerivedElements
WebDerivedElements getDerivedElements()
- Since:
- MicroStrategy Web 9.0.0
-
hasDerivedElements
boolean hasDerivedElements()
- Since:
- MicroStrategy Web 9.0.0
-
hasDerivedElements
boolean hasDerivedElements(WebWorkingSet ws)
-
getTransactableUnit
WebTransactableUnit getTransactableUnit(java.lang.String formID)
-
findTransactableUnit
WebTransactableUnit findTransactableUnit(java.lang.String formID)
Return aWebTransactableUnit
without modifying the internal collection of transactable units- Parameters:
formID
-String
containing form GUID to retrieve unit of- Returns:
WebTransactableUnit
of form with specified ID. Null if not found
-
isDerived
boolean isDerived()
Specifies if this represents a derived attribute.- Returns:
- True if this is a derived attribute, false otherwise.
-
getKey
int getKey()
Returns the key of the attribute on the template.- Returns:
- The key of the attribute.
-
setThresholdCount
void setThresholdCount(int count)
set The number of thresholds defined for this attribute.
-
getThresholdCount
int getThresholdCount()
- Returns:
- The number of thresholds defined for this attribute.
-
setThresholdsEnabled
void setThresholdsEnabled(boolean enabled)
set The thresholds enabled prop.
-
getThresholdsEnabled
boolean getThresholdsEnabled()
-
setShowThresholds
void setShowThresholds(boolean show)
- Parameters:
show
- whether to thresholds associated with this template metric
-
-