Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

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

abstract void	addDetails(boolean details) This method will add or remove details from the display unit.
abstract void	applyVisitor(DisplayUnitsVisitor visitor, boolean deep)
abstract boolean	canHighlight()
abstract WebDisplayUnits	getChildUnits() Returns the collection of child display units, or null if the object is not a collection.
abstract String	getDisplayName() Returns the display name associated with this object.
abstract int	getDisplayUnitType() Returns the type of display unit that this object represents.
abstract String	getID() Returns the DSS ID of the display unit.
abstract boolean	hasDetails() Returns whether this display unit currently has details enabled.
abstract void	highlightUnit() Sets this display unit to be highlighted.
abstract void	highlightUnit(boolean details) Sets this display unit to be highlighted.
abstract boolean	isHighlighted() Returns whether this unit is highlighted.
abstract boolean	isObjectInfo() Returns true if underlying Web Object can be cast to `WebObjectInfo`.
abstract boolean	isSelected() Returns whether this display unit is selected.
abstract void	setDisplayName(String displayName) This method will set the value of the display name.
abstract void	setSelected(boolean selected) Sets the current unit's selection status.

From interface com.microstrategy.web.objects.WebFeatures

From interface com.microstrategy.web.objects.WebFilterBase

From interface com.microstrategy.web.objects.WebObjectInfo

abstract void	buildShortObjectAttributes(WebXMLBuilder builder)
abstract void	buildShortXML(WebXMLBuilder builder)
abstract String	getAbbreviation() Returns the abbreviation of this object.
abstract int	getAccessGranted() Returns the current access granted on this object, if available.
abstract SimpleList	getAncestors() Returns a `SimpleList` containing the ancestors of this object, if they exist in the object XML.
abstract WebCertifiedInfo	getCertifiedInfo()
abstract String[]	getComments() Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object.
abstract String	getContainerDid()
abstract String	getContainerType()
abstract String	getCreationTime() Returns the creation time of this object, if that information is available.
abstract long	getCreationTimeStamp() Get the object creation timestamp in millisecond.
abstract String	getDataSources()
abstract String	getDescription() Returns the description of the object.
abstract int	getExtendedType() The current extended type
abstract WebObjectsFactory	getFactory() Returns WebObjectsFactory
abstract int	getFlags() Returns the flags which determine what data to populate upon calling populate.
abstract String	getID() Returns the DSS ID of the object, if one exists.
abstract String	getIconPath() Return the icon path for the object
abstract String	getModificationTime() Returns the last modification time of the object, if that information is available.
abstract long	getModificationTimeStamp() Get the object modification timestamp in millisecond.
abstract String	getName() Returns the name of this object.
abstract boolean	getNonSchedulable() Get flag of whether the object is not schedulable
abstract int	getOtherNameTransCount() Returns the count of name translations for locales other than the current effective locale.
abstract WebObjectInfo	getOwner() Returns a WebObjectInfo object which corresponds to the owner of this object.
abstract WebFolder	getParent() Returns the parent folder of the current object, if it exists.
abstract int	getPreSaveAsFlags() Returns the flags which determine the previous save as prompt flag.
abstract String	getProjectId()
abstract String	getProjectName()
abstract int	getPropertyFlags() Retrieve the current property flags
abstract SimpleList	getPropertySetFilter() Returns an editable `SimpleList` where you can specify the list of propertySets that the getPropertySets call should be limited to Note that this filter is not retained in the state.
abstract WebPropertyGroup	getPropertySets() Returns the property sets associated with this object.
abstract WebRecommendationInfo	getRecommendationInfo() This contains all the information related to a recommendation search
abstract WebObjectSecurity	getSecurity() Returns the `WebObjectSecurity` object associated with this WebObjectInfo object.
abstract int	getState() Returns the state of the object.
abstract int	getSubType() Returns the subtype of the object.
abstract int	getType() Returns the type of this object.
abstract String	getVersionID() Returns the Version ID of the object, if one exists.
abstract WebViewMediaSettings	getViewMediaSettings()
abstract int	getVisualizationViewMode()
abstract String	getXML(boolean encode) Returns the XML representation of this object.
abstract String	getXML() Returns the XML representation of this object.
abstract boolean	hasOwner()
abstract boolean	isAncestorNamedFolder(int folderName) Returns whether the named folder is this object's ancestor.
abstract boolean	isDirty() Returns whether this object has been modified to be different from the object in metadata.
abstract boolean	isEmbedded()
abstract boolean	isHidden() Returns whether the object is a hidden object.
abstract boolean	isNew() Returns whether this object is newly created at client side, which is not in the metadata.
abstract boolean	isPopulated() Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.
abstract void	populate(String xml) Populates the fields on this object by loading the given object definition XML.
abstract void	populate() Populates the fields on this object by asking the Intelligence Server for the object definition.
abstract void	setAbbreviation(String abbreviation)
abstract void	setComments(String[] comments) Set the long description of the object as an array of strings.
abstract void	setDataSources(String dataSourcesXML)
abstract void	setDescription(String description) Sets the description of the object.
abstract void	setExtendedType(int extendedType) Set the current extended type
abstract void	setFlags(int flags) Sets the flags which determine what data to populate upon calling populate.
abstract void	setHidden(boolean hidden) Sets whether the object is a hidden object.
abstract void	setIconPath(String iconPath) Set the icon path for the object
abstract void	setName(String _name)
abstract void	setNonSchedulable(boolean nonSchedulable) Set flag of whether the object is not schedulable
abstract void	setPreSaveAsFlags(int flags) Sets the flags which determine the previous save as prompt flag.
abstract void	setPropertyFlags(int flags) Set the current property flags

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

Interfaces

Classes

Enums

Exceptions

WebCustomGroup

Class Overview

Summary

Public Methods

public abstract int getAggregation ()

Returns

public abstract String[] getBandNames ()

Returns

public abstract WebFormat getChildGridFormat ()

Throws

public abstract WebFormat getChildHeaderFormat ()

Throws

public abstract int getDisplayOption ()

public abstract WebFormat getGridFormat ()

Throws

public abstract WebFormat getHeaderFormat ()

Throws

public abstract int getReportFilterInteraction ()

public abstract boolean isFlatten ()

Returns

public abstract boolean isParentFirst ()

Returns

public abstract void setAggregation (int aggregation)

Parameters

public abstract void setBandNames (String[] names)

Parameters

public abstract void setDisplayOption (int option)

Parameters

public abstract void setFlatten (boolean flatten)

Parameters

public abstract void setNodeKey (int nodeKey)

public abstract void setParentFirst (boolean parentFirst)

Parameters

public abstract void setReportFilterInteraction (int value)