Package com.microstrategy.web.app.beans

Interface SortEditorBean

All Superinterfaces:

AppComponent, EnumWebPersistableState, FrameElement, Persistable, ReportFrameElement, RequestPersistable, Transformable, ViewBeanParserBean, WebComponent

public interface SortEditorBean
extends ViewBeanParserBean, ReportFrameElement

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.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields

Modifier and Type	Field	Description
static int	COL_TAB
static int	ROW_TAB	Constant value indicating the tabs on the editor
static int	SORT_GROUP_BY_UNITS	Constant value indicating group by units are to be sorted
static java.lang.String	SORT_KEY_SEPERATOR	Constant value for the value separator character for sorting
static int	SORT_TEMPLATE_UNITS	Constant value indicating template units are to be sorted

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent

COMPONENT_POSITION_NOT_INITIALIZED

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
java.util.ArrayList	getAppliedSorts(int type)	Deprecated. Please us public getAppliedSortsByAxis(int type, int axis)
java.util.ArrayList	getAppliedSortsByAxis(int type, int axis)
int	getCurrentTab()	Returns the current tab
java.lang.String	getDetailsSectionKey()	Returns the RW SortEditor Details Section Key
java.util.ArrayList	getGroupByForms(java.lang.String attribute)
int	getMaxSortAllowed()	Deprecated. User can add extra sort from the layout.
java.util.ArrayList	getSortByUnits(int type)
java.util.ArrayList	getSortByUnitsByAxis(int type, int axis)
WebSorts	getSorts(int axis)
void	setCurrentTab(int currentTab)	Sets the current tab
void	setMaxSortAllowed(int maxSortAllowed)	Sets how many sorts are allowed to the user

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent

getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop

Methods inherited from interface com.microstrategy.web.app.beans.FrameElement

getFrameBean, getTargetBean, getTargetBeanPath, getUseIFrame, isEditor, isEnabled, setTargetBean, setTargetBeanPath, setUseIFrame

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

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.app.beans.ReportFrameElement

getReportFrameBean, isGridDataNecessary

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable

restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.beans.Transformable

addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.app.beans.ViewBeanParserBean

getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, setActiveElementIndex, setActiveViewKey

Methods inherited from interface com.microstrategy.web.beans.WebComponent

addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setWebEventHandler

Field Detail

SORT_KEY_SEPERATOR

static final java.lang.String SORT_KEY_SEPERATOR

Constant value for the value separator character for sorting

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

SORT_TEMPLATE_UNITS

static final int SORT_TEMPLATE_UNITS

Constant value indicating template units are to be sorted

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

SORT_GROUP_BY_UNITS

static final int SORT_GROUP_BY_UNITS

Constant value indicating group by units are to be sorted

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

ROW_TAB

static final int ROW_TAB

Constant value indicating the tabs on the editor

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

COL_TAB

static final int COL_TAB

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Method Detail

getSortByUnits

java.util.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

Since:

MicroStrategy Web 8.0.0

getSortByUnitsByAxis

java.util.ArrayList getSortByUnitsByAxis(int type,
                                         int axis)

Since:

MicroStrategy Web 9.0.0

getGroupByForms

java.util.ArrayList getGroupByForms(java.lang.String attribute)

Parameters:

attribute - name of the attribute from where the forms will be retrieved

Returns:

an ArrayList instance with the group by forms

Since:

MicroStrategy Web 8.0.0

getAppliedSorts

java.util.ArrayList getAppliedSorts(int type)

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

Since:

MicroStrategy Web 8.0.0

getAppliedSortsByAxis

java.util.ArrayList getAppliedSortsByAxis(int type,
                                          int axis)

Since:

MicroStrategy Web 9.0.0

getMaxSortAllowed

int getMaxSortAllowed()

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

setMaxSortAllowed

void setMaxSortAllowed(int maxSortAllowed)

Sets how many sorts are allowed to the user

Parameters:

maxSortAllowed - the number of sorts presented to the user

getCurrentTab

int getCurrentTab()

Returns the current tab

Returns:

type int value indicating the current tab, value ROW_TAB or COL_TAB

Since:

MicroStrategy Web 9.0.0

setCurrentTab

void setCurrentTab(int currentTab)

Sets the current tab

Parameters:

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

Since:

MicroStrategy Web 9.0.0

getDetailsSectionKey

java.lang.String getDetailsSectionKey()

Returns the RW SortEditor Details Section Key

Returns:

Returns the Sort Document Details Section Key

Since:

MicroStrategy Web 9.0.0

getSorts

WebSorts getSorts(int axis)
           throws WebObjectsException,
                  WebBeanException

Throws:

WebObjectsException

WebBeanException