public interface

SortEditorBean

implements ReportFrameElement ViewBeanParserBean
com.microstrategy.web.app.beans.SortEditorBean

Class Overview

The SortEditorBean supports the Advanced Sort Editor. It uses an standard microstrategy gui editor. The user will use this editor to select the keys she wants to sort from and the sorting order.

Summary

Constants
int COL_TAB
int ROW_TAB Constant value indicating the tabs on the editor
int SORT_GROUP_BY_UNITS Constant value indicating group by units are to be sorted
String SORT_KEY_SEPERATOR Constant value for the value separator character for sorting
int SORT_TEMPLATE_UNITS Constant value indicating template units are to be sorted
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract ArrayList getAppliedSorts(int type)
This method is deprecated. Please us public getAppliedSortsByAxis(int type, int axis)
abstract ArrayList getAppliedSortsByAxis(int type, int axis)
abstract int getCurrentTab()
Returns the current tab
abstract String getDetailsSectionKey()
Returns the RW SortEditor Details Section Key
abstract ArrayList getGroupByForms(String attribute)
abstract int getMaxSortAllowed()
This method is deprecated. User can add extra sort from the layout.
abstract ArrayList getSortByUnits(int type)
abstract ArrayList getSortByUnitsByAxis(int type, int axis)
abstract WebSorts getSorts(int axis)
abstract void setCurrentTab(int currentTab)
Sets the current tab
abstract void setMaxSortAllowed(int maxSortAllowed)
Sets how many sorts are allowed to the user
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.FrameElement
From interface com.microstrategy.web.app.beans.ReportFrameElement
From interface com.microstrategy.web.app.beans.ViewBeanParserBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final int COL_TAB

Constant Value: 1 (0x00000001)

public static final int ROW_TAB

Constant value indicating the tabs on the editor

Constant Value: 0 (0x00000000)

public static final int SORT_GROUP_BY_UNITS

Constant value indicating group by units are to be sorted

Constant Value: 2 (0x00000002)

public static final String SORT_KEY_SEPERATOR

Constant value for the value separator character for sorting

Constant Value: "!"

public static final int SORT_TEMPLATE_UNITS

Constant value indicating template units are to be sorted

Constant Value: 1 (0x00000001)

Public Methods

public abstract ArrayList getAppliedSorts (int type)

This method is deprecated.
Please us public getAppliedSortsByAxis(int type, int axis)

Parameters
type int value indicating the type of sort units to check for, values from SORT_TEMPLATE_UNITS or SORT_GROUP_BY_UNITS
Returns
  • an ArrayList instance with the applied sorts

public abstract ArrayList getAppliedSortsByAxis (int type, int axis)

public abstract int getCurrentTab ()

Returns the current tab

Returns

public abstract String getDetailsSectionKey ()

Returns the RW SortEditor Details Section Key

Returns
  • Returns the Sort Document Details Section Key

public abstract ArrayList getGroupByForms (String attribute)

Parameters
attribute name of the attribute from where the forms will be retrieved
Returns
  • an ArrayList instance with the group by forms

public abstract int getMaxSortAllowed ()

This method is deprecated.
User can add extra sort from the layout.

Defines how many sorts are allowed to the user

Returns
  • the number of sorts presented to the user

public abstract ArrayList getSortByUnits (int type)

Parameters
type int value indicating the type of sort units to return, values from SORT_TEMPLATE_UNITS or SORT_GROUP_BY_UNITS
Returns
  • an ArrayList instance with the sort by units

public abstract ArrayList getSortByUnitsByAxis (int type, int axis)

public abstract WebSorts getSorts (int axis)

public abstract void setCurrentTab (int currentTab)

Sets the current tab

Parameters
currentTab int value indicating the current tab, value ROW_TAB or COL_TAB

public abstract void setMaxSortAllowed (int maxSortAllowed)

Sets how many sorts are allowed to the user

Parameters
maxSortAllowed the number of sorts presented to the user