Package com.microstrategy.web.objects
Interface WebMetricHierarchicalSort
-
- All Superinterfaces:
WebMetricSort
,WebSort
public interface WebMetricHierarchicalSort extends WebMetricSort
This interface represents a metric hierarchical sort. This interface contains the methods which are relevant only for a metric hierarchical sort.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description WebTemplateMetricSubtotal
getSubtotal()
Deprecated.UsegetTemplateSubtotal()
insteadWebTemplateSubtotal
getTemplateSubtotal()
Returns the subtotal has been defined for this hierarchical sort.void
setSubtotal(WebTemplateMetricSubtotal subtotal)
Deprecated.UsesetSubtotal(WebTemplateSubtotal)
insteadvoid
setSubtotal(WebTemplateSubtotal subtotal)
Sets aWebTemplateSubtotal
to be the subtotal definition for this hierarchical sort.void
setSubtotalByType(int subtotalType)
Sets the subtotal definition for the sort by specifying its subtotal type.-
Methods inherited from interface com.microstrategy.web.objects.WebMetricSort
getElements, getMetric, setMetric
-
Methods inherited from interface com.microstrategy.web.objects.WebSort
getKey, getPosition, getRespectParent, getSortType, getSubtotalsPosition, getTarget, isAscending, setAscending, setRespectParent, setSubtotalsPosition
-
-
-
-
Method Detail
-
getSubtotal
WebTemplateMetricSubtotal getSubtotal()
Deprecated.UsegetTemplateSubtotal()
insteadReturns the subtotal has been defined for this hierarchical sort.- Returns:
- The currently set
WebTemplateMetricSubtotal
object. This will be null if it has not been set. - See Also:
setSubtotal(com.microstrategy.web.objects.WebTemplateMetricSubtotal)
-
setSubtotal
void setSubtotal(WebTemplateMetricSubtotal subtotal)
Deprecated.UsesetSubtotal(WebTemplateSubtotal)
insteadSets aWebTemplateMetricSubtotal
to be the subtotal definition for this hierarchical sort.- Parameters:
subtotal
- TheWebTemplateMetricSubtotal
object to serve as the definition. This object should come from the template that this sort object is associated with.- See Also:
getSubtotal()
-
setSubtotalByType
void setSubtotalByType(int subtotalType) throws java.lang.IllegalArgumentException
Sets the subtotal definition for the sort by specifying its subtotal type. This method will look up the correspondingWebTemplateSubtotal
object with the given type. Note that the setSubtotal method must be called to set a custom subtotal as the subject of the sort.- Parameters:
subtotalType
- The subtotal type to search for, fromEnumDSSXMLMetricType
.- Throws:
java.lang.IllegalArgumentException
- Thrown if the subtotalType is not a valid value, if the subtotal type given is DssXmlMetricSubtotal, or if the given subtotal is not currently set on the associated metric.
-
getTemplateSubtotal
WebTemplateSubtotal getTemplateSubtotal()
Returns the subtotal has been defined for this hierarchical sort.- Returns:
- The currently set
WebTemplateSubtotal
object. This will be null if it has not been set. - Since:
- MicroStrategy Web 9.0.0
- See Also:
setSubtotal(com.microstrategy.web.objects.WebTemplateMetricSubtotal)
-
setSubtotal
void setSubtotal(WebTemplateSubtotal subtotal)
Sets aWebTemplateSubtotal
to be the subtotal definition for this hierarchical sort.- Parameters:
subtotal
- TheWebTemplateSubtotal
object to serve as the definition. This object should come from the template that this sort object is associated with.- Since:
- MicroStrategy Web 9.0.0
- See Also:
getSubtotal()
-
-