public interface

WebCustomGroup

implements WebFilterBase
com.microstrategy.web.objects.WebCustomGroup

Class Overview

The WebCustomGroup interface represents a custom group object.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract int getAggregation()
Returns an integer value from EnumDSSXMLAEAggregation indicating whether the aggregation over the custom group is allowed.
abstract String[] getBandNames()
Get the names of all the bands for a custom group element.
abstract WebFormat getChildGridFormat()
Returns the WebFormat object for the values/data of the custom group element's invidual items.
abstract WebFormat getChildHeaderFormat()
Returns the WebFormat object for the header of the custom group element's invidual items.
abstract int getDisplayOption()
Get the display option of the custom group element, from EnumWebCustomGroupDisplayOptions.
abstract WebFormat getGridFormat()
Returns the WebFormat object for the values/data of the custom group element.
abstract WebFormat getHeaderFormat()
Returns the WebFormat object for the header of the custom group element.
abstract int getReportFilterInteraction()
Get the report filter interaction property value.
abstract boolean isFlatten()
Returns a boolean value indicating whether the custom group should be displayed flatten or hierarchically.
abstract boolean isParentFirst()
Returns a boolean value indicating the order between parent and child elements.
abstract void setAggregation(int aggregation)
Sets an integer value from EnumDSSXMLAEAggregation indicating whether the aggregation over the custom group is allowed.
abstract void setBandNames(String[] names)
Set the names of the bands of custom group element.
abstract void setDisplayOption(int option)
Set the display option of the custom group element.
abstract void setFlatten(boolean flatten)
Sets a boolean value indicating whether the custom group should be displayed flatten or hierarchically.
abstract void setNodeKey(int nodeKey)
Set the key of the custom group element obtained from getKey().
abstract void setParentFirst(boolean parentFirst)
Sets a boolean value indicating the order between parent and child elements.
abstract void setReportFilterInteraction(int value)
Set the report filter interaction property value.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebFilterBase
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract int getAggregation ()

Returns an integer value from EnumDSSXMLAEAggregation indicating whether the aggregation over the custom group is allowed.

Returns
  • an integer value indicating whether the aggregation over the custom group is allowed.

public abstract String[] getBandNames ()

Get the names of all the bands for a custom group element. The key of the custom group element that is obtained from getKey() should be set using setNodeKey(int) prior to calling this method.

Returns
  • Array of String where each element is a name of a band

public abstract WebFormat getChildGridFormat ()

Returns the WebFormat object for the values/data of the custom group element's invidual items. The key of the custom group element that is obtained from getKey() should be set using setNodeKey(int) prior to calling this method.

Throws
IllegalArgumentException if setNodeKey(int) has not been called or if a custom group element cannot be found with the set key.

public abstract WebFormat getChildHeaderFormat ()

Returns the WebFormat object for the header of the custom group element's invidual items. The key of the custom group element that is obtained from getKey() should be set using setNodeKey(int) prior to calling this method.

Throws
IllegalArgumentException if setNodeKey(int) has not been called or if a custom group element cannot be found with the set key.

public abstract int getDisplayOption ()

Get the display option of the custom group element, from EnumWebCustomGroupDisplayOptions. The key of the custom group element that is obtained from getKey() should be set using setNodeKey(int) prior to calling this method.

public abstract WebFormat getGridFormat ()

Returns the WebFormat object for the values/data of the custom group element. The key of the custom group element that is obtained from getKey() should be set using setNodeKey(int) prior to calling this method.

Throws
IllegalArgumentException if setNodeKey(int) has not been called or if a custom group element cannot be found with the set key.

public abstract WebFormat getHeaderFormat ()

Returns the WebFormat object for the header of the custom group element. The key of the custom group element that is obtained from getKey() should be set using setNodeKey(int) prior to calling this method.

Throws
IllegalArgumentException if setNodeKey(int) has not been called or if a custom group element cannot be found with the set key.

public abstract int getReportFilterInteraction ()

Get the report filter interaction property value. Specified by the EnumWebCustomGroupReportFilterInteraction

public abstract boolean isFlatten ()

Returns a boolean value indicating whether the custom group should be displayed flatten or hierarchically.

Returns
  • a boolean value indicating how to display the custom group.

public abstract boolean isParentFirst ()

Returns a boolean value indicating the order between parent and child elements.

Returns
  • a boolean value indicating the order between parent and child elements.

public abstract void setAggregation (int aggregation)

Sets an integer value from EnumDSSXMLAEAggregation indicating whether the aggregation over the custom group is allowed.

Parameters
aggregation an integer value indicating whether the aggregation over the custom group is allowed.

public abstract void setBandNames (String[] names)

Set the names of the bands of custom group element. The key of the custom group element that is obtained from getKey() should be set using setNodeKey(int) prior to calling this method.

Parameters
names Array of String where each element is a name of a band

public abstract void setDisplayOption (int option)

Set the display option of the custom group element. The key of the custom group element that is obtained from getKey() should be set using setNodeKey(int) prior to calling this method.

Parameters
option - value from EnumWebCustomGroupDisplayOptions

public abstract void setFlatten (boolean flatten)

Sets a boolean value indicating whether the custom group should be displayed flatten or hierarchically.

Parameters
flatten a boolean value indicating how to display the custom group.

public abstract void setNodeKey (int nodeKey)

Set the key of the custom group element obtained from getKey(). Once the key is set, properties of the custom group element can be obtained from getChildGridFormat(), getChildHeaderFormat(), getGridFormat(), getChildHeaderFormat()} etc.

public abstract void setParentFirst (boolean parentFirst)

Sets a boolean value indicating the order between parent and child elements.

Parameters
parentFirst a boolean value indicating the order between parent and child elements.

public abstract void setReportFilterInteraction (int value)

Set the report filter interaction property value. The valid values are specified by EnumWebCustomGroupReportFilterInteraction