public interface

RWGroupBy

com.microstrategy.web.objects.rw.RWGroupBy

Class Overview

Represent group by element.

Summary

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

Public Methods

public abstract void addHeaderFooter (String headerKey, String headerSubsectionKey, String footerKey, 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

public abstract int getAttributeFormsDisplayType ()

Return the way forms should be displayed

Returns

public abstract WebAttributeForms getDisplayAttributeForms ()

Return the forms should be displayed

Returns
  • type WebAttributeForms

public abstract String getKey ()

Returns a group by object key.

Returns
  • a group by object key.

public abstract int getLevel ()

Returns groub by level. Possible values are defined in EnumRWGroupByLevels

Returns
  • groub by level

public abstract RWGroupBy getNext ()

Returns next group by or null

Returns
  • next group by or null

public abstract RWGroupBy getPrevious ()

Returns previous group by or null

Returns
  • previous group by or null

public abstract RWSectionDef getSection ()

Returns group by section definition assosiated with this group by.

Returns
  • group by section definition assosiated with this group by.

public abstract 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.

public abstract RWSubtotals getSubtotals ()

public abstract RWGroupByUnit getUnit ()

Returns group by unit associated with this group by.

Returns
  • group by unit associated with this group by

public abstract void setAttributeFormsDisplayType (int type)

Specify the way forms should be displayed for this control

Parameters
type int from EnumDSSXMLControlAttributeFormDisplayOption
Throws
WebObjectsException

public abstract void setDisplayAttributeForms (List<String> forms)

Specify the forms should be displayed for this control

Throws
WebObjectsException