| com.microstrategy.web.objects.WebTemplateSubtotal |
The WebTemplateSubtotal interface represents a subtotal of a single
type within the WebTemplateSubtotals collection. This interface allows
the user to gather information about and turn on/off the subtotal.
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract WebSubtotalInstance |
createInstance(int type)
Creates a WebSubtotalInstance of the appropriate type and associates it to the
subtotal.
| ||||||||||
| abstract void |
deActivate()
Inactivates the
WebTemplateSubtotal object. | ||||||||||
| abstract WebMetric |
getDefinition()
Returns the definition of a custom subtotal.
| ||||||||||
| abstract int |
getIndex()
Returns the index of the subtotal within the
WebTemplateSubtotals collection. | ||||||||||
| abstract WebSubtotalInstance |
getInstance()
Returns the WebSubtotalInstance associated with the subtotal.
| ||||||||||
| abstract String |
getName()
Returns the name of the subtotal.
| ||||||||||
| abstract WebTemplateSubtotal |
getSubtotalForMetric(WebMetric metric)
Returns the subtotal set for a given metric.
| ||||||||||
| abstract int |
getTemplateSubtotalType()
Returns the subtotal type of the subtotal.
| ||||||||||
| abstract int |
getType()
Returns the type of subtotal.
| ||||||||||
| abstract boolean |
isActive()
Returns whether the subtotal is active.
| ||||||||||
Creates a WebSubtotalInstance of the appropriate type and associates it to the subtotal. If the subtotal already has a subtotal instance of different type associated with it, this call will clear the original subtotal instance, create a new WebSubtotalInstance and return it. Otherwise it will just return the current subtotal instance.
| type | type of subtotal instance from EnumSubtotalInstanceType
|
|---|
Inactivates the WebTemplateSubtotal object. This will clear the
WebSubtotalInstance associated with the subtotal and generate the
appropriate delta
Returns the definition of a custom subtotal. A custom subtotal is a subtotal whose type is EnumDSSXMLMetricType.DssXmlMetricSubtotal.
WebMetric.| UnsupportedOperationException | Thrown if the subtotal is not a custom subtotal, that is, its subtotal type is not EnumDSSXMLMetricType.DssXmlMetricSubtotal. |
|---|
Returns the index of the subtotal within the WebTemplateSubtotals collection.
Returns the WebSubtotalInstance associated with the subtotal. The WebSubtotalInstance can then be used to get more information about how the subtotal has been defined, like whether the subtotal is set by position or by level (units) or by group by etc. If the subtotal has not been turned on, then it will return null
WebSubtotalInstance object that holds information about how the subtotal is active
Returns the name of the subtotal. Example, Average, Total etc.
Returns the subtotal set for a given metric. Mainly used for 'List Subtotals' or 'Custom subtotals' where you can define the subtotal function (average, sum, minimum etc) to be used for each metric on the template. For a 'definition' subtotal, this method will return itself.
| metric | Metric whose subtotal is required. |
|---|
Returns the subtotal type of the subtotal. This value indicates whether a
subtotal is a definition subtotal or a list subtotal. A list subtotal is
a Desktop created 'Custom' subtotal.
This value is from EnumDSSXMLTemplateSubtotalType
Returns the type of subtotal.
EnumDSSXMLMetricType, corresponding to the subtotal
type.
Returns whether the subtotal is active. A subtotal is active if it is turned on for the report. The subtotal may be turned on by position, across level or grouped by template units for the report.