public interface

WebOptimizedDrillPathSettings

com.microstrategy.web.objects.WebOptimizedDrillPathSettings

Summary

Public Methods
abstract void excludeDrillPathsInXML()
Indicates that Optimized drill paths should not be included in the XML.
abstract boolean getDesired()
This would return the value of the desired flag.
abstract int getMinImportance()
This would return the importance index set for optimized drill paths to be fetchd from IServer.
abstract boolean getWithin()
This would return the value of the within flag.
abstract boolean isDrillPathsOptimizationSet()
This would indicate whether the flags are configured to include optimized drill paths in the xml.
abstract boolean isIncludeTemplateDrillPathsSet()
This would indicate whether the flags are configured to include template drill paths..
abstract void setDesired(boolean desired)
This would set if we need the desired flag for the report.
abstract void setMinImportance(int minImportance, boolean includeTemplateDrillPaths)
Indicates that Optimized drill paths of specified importance (and higher) will be included in the XML.
abstract void setWithin(boolean within)
This would set if we need the within flag for the report.

Public Methods

public abstract void excludeDrillPathsInXML ()

Indicates that Optimized drill paths should not be included in the XML.

public abstract boolean getDesired ()

This would return the value of the desired flag. The value is set using setDesired(boolean)

Returns
  • value of the desired flag.

public abstract int getMinImportance ()

This would return the importance index set for optimized drill paths to be fetchd from IServer. The value is set using setMinImportance(int, boolean)

Returns
  • value from EnumDSSXMLDrillImportance.

public abstract boolean getWithin ()

This would return the value of the within flag. The value is set using setWithin(boolean)

Returns
  • value of the within flag.

public abstract boolean isDrillPathsOptimizationSet ()

This would indicate whether the flags are configured to include optimized drill paths in the xml. The value is set using setMinImportance(int, boolean) Optimized drill paths can be disabled using excludeDrillPathsInXML() too.

Returns
  • .True if the result flags are configured to include optimized drill paths.

public abstract boolean isIncludeTemplateDrillPathsSet ()

This would indicate whether the flags are configured to include template drill paths.. The value is set using setMinImportance(int, boolean)

Returns
  • .True if the result flags are configured to include template drill paths.

public abstract void setDesired (boolean desired)

This would set if we need the desired flag for the report. Setting this flag will "intersect" the template level grid proeprties with the web preference for drill options and the user will never get more paths that he asked for.

Parameters
desired Set to true if we need to set the desired flag.

public abstract void setMinImportance (int minImportance, boolean includeTemplateDrillPaths)

Indicates that Optimized drill paths of specified importance (and higher) will be included in the XML. The minImportance argument would specify the minimum importance index for drill paths to be fetched from IServer. The values can be from EnumDSSXMLDrillImportance. The values cannot be ORed. Setting a importance value (say medium) would ensure that drill paths of that and higher importance (i.e. medium and high, in this case) would be fetched from IServer.

Parameters
minImportance value from EnumDSSXMLDrillImportance.
includeTemplateDrillPaths set to True if template drill paths should be included.

public abstract void setWithin (boolean within)

This would set if we need the within flag for the report. Setting this flag will would mean that we would receive the "within" paths along with the other paths.

Parameters
within desired Set to true if we need to set the within flag.