Package com.microstrategy.web.app.beans

Interface FunctionEditorBean

All Superinterfaces:

AppComponent, DataSetParserBean, TemplateElementsBean, Transformable, ViewBeanParserBean, WebComponent

public interface FunctionEditorBean
extends TemplateElementsBean

Since:

MicroStrategy Web 9.0.0

Field Summary

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

COMPONENT_POSITION_NOT_INITIALIZED

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

ALL_DATASET_MODE, DATASET_MODE, GRID_MODE

Method Summary

Modifier and Type	Method	Description
java.util.Iterator	getFolderList()	Returns the list of functions to be displayed.
int	getSelectedCategoryIndex()	Returns the current selected category index on the bean.
WebFunction	getSelectedFunction()	Returns the current function.
java.lang.String	getSelectedFunctionId()	Returns the current function name on the bean.
int	getSelectedFunctionIndex()	Returns the current selected function index on the bean.
void	setSelectedCategoryIndex(int categoryIndex)	Set the current selected category index on the bean.
void	setSelectedFunctionId(java.lang.String functionId)	Set the current function name on the bean.
void	setSelectedFunctionIndex(int functionIndex)	Set the current selected function index on the bean.

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.DataSetParserBean

getActiveDatasetId, getUserMetricsFromDataset, setActiveDatasetId

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

getDatasets, getMode, getTemplateElementsList, getWebTemplate, getWebWorkingSet, setMode

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, getTargetBean, getTargetBeanPath, 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, setTargetBean, setTargetBeanPath, setWebEventHandler

Method Detail

getFolderList

java.util.Iterator getFolderList()

Returns the list of functions to be displayed.

Returns:

Iterator - iterator through a WebFunction collection.

setSelectedFunctionId

void setSelectedFunctionId(java.lang.String functionId)

Set the current function name on the bean.

Parameters:

functionId - function name

getSelectedFunctionId

java.lang.String getSelectedFunctionId()

Returns the current function name on the bean.

Returns:

functionName set on the bean.

setSelectedCategoryIndex

void setSelectedCategoryIndex(int categoryIndex)

Set the current selected category index on the bean.

Parameters:

categoryIndex -

getSelectedCategoryIndex

int getSelectedCategoryIndex()

Returns the current selected category index on the bean.

Returns:

categoryIndex set on the bean.

setSelectedFunctionIndex

void setSelectedFunctionIndex(int functionIndex)

Set the current selected function index on the bean.

Parameters:

functionIndex -

getSelectedFunctionIndex

int getSelectedFunctionIndex()

Returns the current selected function index on the bean.

Returns:

functionIndex set on the bean.

getSelectedFunction

WebFunction getSelectedFunction()

Returns the current function.

Returns:

returns the current function. If the functionName is not set, it returns null.