Package com.microstrategy.web.objects.rw

Interface RWGroupBy

public interface RWGroupBy

Represent group by element.

Since:

MicroStrategy Web 8.0.0

Method Summary

Modifier and Type	Method	Description
void	addHeaderFooter(java.lang.String headerKey, java.lang.String headerSubsectionKey, java.lang.String footerKey, java.lang.String footerSubsectionKey)	Adds a header/footer and corresponding subsections to the group by section.
int	getAttributeFormsDisplayType()	Return the way forms should be displayed
WebAttributeForms	getDisplayAttributeForms()	Return the forms should be displayed
java.lang.String	getKey()	Returns a group by object key.
int	getLevel()	Returns groub by level.
RWGroupBy	getNext()	Returns next group by or null
RWGroupBy	getPrevious()	Returns previous group by or null
RWSectionDef	getSection()	Returns group by section definition assosiated with this group by.
WebSorts	getSorts()	Returns the WebSorts collection, which allows the user to examine and change the sorting settings on the axis.
RWSubtotals	getSubtotals()
RWGroupByUnit	getUnit()	Returns group by unit associated with this group by.
void	setAttributeFormsDisplayType(int type)	Specify the way forms should be displayed for this control
void	setDisplayAttributeForms(java.util.List<java.lang.String> forms)	Specify the forms should be displayed for this control

Method Detail

getKey

java.lang.String getKey()

Returns a group by object key.

Returns:

a group by object key.

getLevel

int getLevel()

Returns groub by level. Possible values are defined in EnumRWGroupByLevels

Returns:

groub by level

getUnit

RWGroupByUnit getUnit()

Returns group by unit associated with this group by.

Returns:

group by unit associated with this group by

getSection

RWSectionDef getSection()

Returns group by section definition assosiated with this group by.

Returns:

group by section definition assosiated with this group by.

getNext

RWGroupBy getNext()

Returns next group by or null

Returns:

next group by or null

getPrevious

RWGroupBy getPrevious()

Returns previous group by or null

Returns:

previous group by or null

addHeaderFooter

void addHeaderFooter(java.lang.String headerKey,
                     java.lang.String headerSubsectionKey,
                     java.lang.String footerKey,
                     java.lang.String footerSubsectionKey)

Adds a header/footer and corresponding subsections to the group by section. If any of parameters is null corresponding key will be assigned automatically.

Parameters:

headerKey - a header section key

headerSubsectionKey - a headrer subsection key

footerKey - a footer section key

footerSubsectionKey - a footer subsection key

getSorts

WebSorts getSorts()

Returns the WebSorts collection, which allows the user to examine and change the sorting settings on the axis.

Returns:

A WebSorts object which can be used to gather information about and change the settings of the sorts on the axis.

getSubtotals

RWSubtotals getSubtotals()

Since:

MicroStrategy Web 9.0.0

setAttributeFormsDisplayType

void setAttributeFormsDisplayType(int type)
                           throws WebObjectsException

Specify the way forms should be displayed for this control

Parameters:

type - int from EnumDSSXMLControlAttributeFormDisplayOption

Throws:

WebObjectsException

getAttributeFormsDisplayType

int getAttributeFormsDisplayType()

Return the way forms should be displayed

Returns:

int from EnumDSSXMLControlAttributeFormDisplayOption

setDisplayAttributeForms

void setDisplayAttributeForms(java.util.List<java.lang.String> forms)
                       throws WebObjectsException

Specify the forms should be displayed for this control

Parameters:

type - List

Throws:

WebObjectsException

getDisplayAttributeForms

WebAttributeForms getDisplayAttributeForms()

Return the forms should be displayed

Returns:

type WebAttributeForms