Package com.microstrategy.web.objects

Interface WebThresholdsContainer

All Known Subinterfaces:

RWControlDef, RWFieldDef, RWFieldGroupDef, RWGridGraphDef, RWHTMLDef, RWImageDef, RWLayoutSectionDef, RWLineDef, RWPanelStackDef, RWSectionDef, RWShapeDef, RWSubsectionDef, RWTextDef, RWUnitDef, WebTemplateAttribute, WebTemplateMetric

public interface WebThresholdsContainer

The WebThresholdsContainer interface is implemented by any object that can contain thresholds. The methods on this interface can be used to obtain and modify the threshold information for the container. The container can be uniquely identified in its context via the ID.

Since:

MicroStrategy Web 9.0.0

Method Summary

Modifier and Type	Method	Description
WebFormat	getFormat()	Returns the WebFormat object associated with the container.
java.lang.String	getID()	Returns the unique ID that can be used to identify the container.
java.lang.String	getName()	Returns the name of the container.
int	getObjectType()	Returns the type of dss object based on EnumDSSXMLObjectTypes
WebThresholds	getThresholds()	Returns the Thresholds associated with this object.
WebThresholds	getTransactions()	Returns the transaction thresholds associated with this object.
int	getType()	Returns the type of the container.
void	initElementSource(WebAttribute att, WebElementSource elemSource)

Method Detail

getThresholds

WebThresholds getThresholds()

Returns the Thresholds associated with this object.

Returns:

The WebThresholds object associated with this container.

getTransactions

WebThresholds getTransactions()

Returns the transaction thresholds associated with this object.

Returns:

The WebThresholds object associated with this container

getType

int getType()

Returns the type of the container. This will be -1 if the container is a template metric, but will be a value from EnumRWUnitTypes for an RWUnitDef.

Returns:

-1 for a metric container or the RW unit type of the container.

getName

java.lang.String getName()

Returns the name of the container. This is meant to be a displayable name for the container, for example, a metric name if the container applies to a specific metric.

Returns:

The name associated with the container.

getID

java.lang.String getID()

Returns the unique ID that can be used to identify the container.

Returns:

The unique ID of the container.

getFormat

WebFormat getFormat()

Returns the WebFormat object associated with the container.

Returns:

The WebFormat object associated with the container.

initElementSource

void initElementSource(WebAttribute att,
                       WebElementSource elemSource)

getObjectType

int getObjectType()

Returns the type of dss object based on EnumDSSXMLObjectTypes