public interface

WebTemplateConsolidation

com.microstrategy.web.objects.WebTemplateConsolidation

Class Overview

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

Summary

Public Methods
abstract int getAxisIndex()
Returns the index of the WebAxis which this template consolidation is on.
abstract WebObjectInfo getConsolidationInfo()
Returns the WebObjectInfo object corresponding to the WebTemplateConsolidation object which it is called on.
abstract int getPosition()
Returns the position of the template consolidation on its axis.
abstract boolean isSubtotalEnabled()
Returns whether subtotals are enabled for the consolidation or not.

Public Methods

public abstract int getAxisIndex ()

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

Returns

public abstract WebObjectInfo getConsolidationInfo ()

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

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

public abstract int getPosition ()

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

Returns
  • The position of the template consolidation.

public abstract 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
  • true if subtotals are enabled.
    false if subtotals are not enabled