Package com.microstrategy.web.objects
Interface WebTemplateConsolidation
- 
public interface WebTemplateConsolidationThe WebTemplateConsolidation interface represents a consolidation contained on a template. This object can be obtained from theWebTemplateUnitobject 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 intgetAxisIndex()Returns the index of theWebAxiswhich this template consolidation is on.WebObjectInfogetConsolidationInfo()Returns theWebObjectInfoobject corresponding to the WebTemplateConsolidation object which it is called on.intgetPosition()Returns the position of the template consolidation on its axis.booleanisSubtotalEnabled()Returns whether subtotals are enabled for the consolidation or not. 
 - 
 
- 
- 
Method Detail
- 
getAxisIndex
int getAxisIndex()
Returns the index of theWebAxiswhich this template consolidation is on.- Returns:
 - The owner axis' index, from 
EnumDSSXMLAxisName. 
 
- 
getPosition
int getPosition()
Returns the position of the template consolidation on its axis. This value is 1-based.- Returns:
 - The position of the template consolidation.
 
 
- 
getConsolidationInfo
WebObjectInfo getConsolidationInfo()
Returns theWebObjectInfoobject corresponding to the WebTemplateConsolidation object which it is called on.- Returns:
 - The 
WebObjectInfoobject which this template consolidation refers to. 
 
- 
isSubtotalEnabled
boolean isSubtotalEnabled()
Returns whether subtotals are enabled for the consolidation or not. This determines whether a subtotal can be defines across the level of the consolidation- Returns:
 trueif subtotals are enabled.
falseif subtotals are not enabled- Since:
 - MicroStrategy Web 9.0.0
 
 
 - 
 
 -