Package com.microstrategy.web.objects

Interface WebCustomGroup

All Superinterfaces:

EnumWebPersistableState, KeyedObject, Persistable, WebDisplayUnit, WebFeatures, WebFilterBase, WebObjectInfo, WebPromptSite

public interface WebCustomGroup
extends WebFilterBase

The WebCustomGroup interface represents a custom group object.

Since:

MicroStrategy Web 8.1.0

Field Summary

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

Modifier and Type	Method	Description
int	getAggregation()	Returns an integer value from EnumDSSXMLAEAggregation indicating whether the aggregation over the custom group is allowed.
java.lang.String[]	getBandNames()	Get the names of all the bands for a custom group element.
WebFormat	getChildGridFormat()	Returns the WebFormat object for the values/data of the custom group element's invidual items.
WebFormat	getChildHeaderFormat()	Returns the WebFormat object for the header of the custom group element's invidual items.
int	getDisplayOption()	Get the display option of the custom group element, from EnumWebCustomGroupDisplayOptions.
WebFormat	getGridFormat()	Returns the WebFormat object for the values/data of the custom group element.
WebFormat	getHeaderFormat()	Returns the WebFormat object for the header of the custom group element.
int	getReportFilterInteraction()	Get the report filter interaction property value.
boolean	isFlatten()	Returns a boolean value indicating whether the custom group should be displayed flatten or hierarchically.
boolean	isParentFirst()	Returns a boolean value indicating the order between parent and child elements.
void	setAggregation(int aggregation)	Sets an integer value from EnumDSSXMLAEAggregation indicating whether the aggregation over the custom group is allowed.
void	setBandNames(java.lang.String[] names)	Set the names of the bands of custom group element.
void	setDisplayOption(int option)	Set the display option of the custom group element.
void	setFlatten(boolean flatten)	Sets a boolean value indicating whether the custom group should be displayed flatten or hierarchically.
void	setNodeKey(int nodeKey)	Set the key of the custom group element obtained from WebNode.getKey().
void	setParentFirst(boolean parentFirst)	Sets a boolean value indicating the order between parent and child elements.
void	setReportFilterInteraction(int value)	Set the report filter interaction property value.

Methods inherited from interface com.microstrategy.utils.KeyedObject

_getObKey

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit

addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

Methods inherited from interface com.microstrategy.web.objects.WebFeatures

isFeatureAvailable, isFeatureAvailable

Methods inherited from interface com.microstrategy.web.objects.WebFilterBase

getDisplayHelper, getExpression, getFilterType, setFilterType

Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo

buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

Methods inherited from interface com.microstrategy.web.objects.WebPromptSite

getPromptInstances

Method Detail

getAggregation

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.

setAggregation

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.

isFlatten

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.

setFlatten

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.

isParentFirst

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.

setParentFirst

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.

getHeaderFormat

WebFormat getHeaderFormat()
                   throws java.lang.IllegalArgumentException

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

Throws:

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

getGridFormat

WebFormat getGridFormat()
                 throws java.lang.IllegalArgumentException

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

Throws:

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

getChildHeaderFormat

WebFormat getChildHeaderFormat()
                        throws java.lang.IllegalArgumentException

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 WebNode.getKey() should be set using setNodeKey(int) prior to calling this method.

Throws:

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

getChildGridFormat

WebFormat getChildGridFormat()
                      throws java.lang.IllegalArgumentException

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 WebNode.getKey() should be set using setNodeKey(int) prior to calling this method.

Throws:

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

setNodeKey

void setNodeKey(int nodeKey)

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

Parameters:

nodeKey -

setDisplayOption

void setDisplayOption(int option)

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

Parameters:

option - - value from EnumWebCustomGroupDisplayOptions

getDisplayOption

int getDisplayOption()

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

setBandNames

void setBandNames(java.lang.String[] names)

Set the names of the bands of custom group element. The key of the custom group element that is obtained from WebNode.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

Since:

MicroStrategy Web 9.0.0

getBandNames

java.lang.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 WebNode.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

Since:

MicroStrategy Web 9.0.0

getReportFilterInteraction

int getReportFilterInteraction()

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

setReportFilterInteraction

void setReportFilterInteraction(int value)

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