Package com.microstrategy.web.app.beans

Class AbstractObjectExplorerBean

java.lang.Object

com.microstrategy.utils.serialization.AbstractPersistable

com.microstrategy.web.beans.AbstractTransformable

com.microstrategy.web.beans.AbstractWebComponent

com.microstrategy.web.app.beans.AbstractAppComponent

com.microstrategy.web.app.beans.AbstractPersistableAppComponent

com.microstrategy.web.app.beans.AbstractPersistableFrameElement

com.microstrategy.web.app.beans.AbstractObjectExplorerBean

All Implemented Interfaces:

EnumWebPersistableState, Persistable, AppComponent, ObjectExplorerBean, RequestPersistable, Transformable, WebComponent

Direct Known Subclasses:

DerivedElementsBrowserBeanImpl, FolderObjectExplorerBeanImpl, XDADataExplorerBeanImpl

public abstract class AbstractObjectExplorerBean
extends AbstractPersistableFrameElement
implements ObjectExplorerBean

Abstract class that represents a basic ObjectExplorerBean

Since:

MicroStrategy Web 8.0.2

Field Summary

Fields inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

STATE_DELIMITOR, STATE_ITEM_SEPARATOR

Fields inherited from class com.microstrategy.web.beans.AbstractWebComponent

_features, _hasJustOpened

Fields inherited from class com.microstrategy.web.beans.AbstractTransformable

_beanContext

Fields inherited from class com.microstrategy.utils.serialization.AbstractPersistable

scriptEndTagEncoder

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

Constructor Summary

Constructors

Constructor	Description
AbstractObjectExplorerBean()

Method Summary

Modifier and Type	Method	Description
int	getBlockBegin()
int	getBlockCount()
java.lang.String	getErrorMessage()
java.lang.String	getTypeRestriction()
void	setBlockBegin(int blockBegin)	Sets the first element on the block (used for incremental fetch)
void	setBlockCount(int blockCount)	Sets the total number of elements on the current block (used for incremental fetch)
void	setErrorMessage(java.lang.String message)
void	setTypeRestriction(java.lang.String type)	Sets a comma-separated String that represents the type of objects (from EnumDSSXMLObjectTypes) to display

Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableFrameElement

doCollectData, getDocumentFrameBean, getFeaturesManager, getFrameBean, getReportFrameBean, getRWFrameBean, getUseIFrame, isEditor, isGridDataNecessary, isIFrameEnabled, isOpen, setIsOpen, setUseIFrame

Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

addChildStateInfo, doFlatState, isCookieOpen, isSaveStateEnabled, saveState, saveState, saveState, saveState

Methods inherited from class com.microstrategy.web.app.beans.AbstractAppComponent

addChildStateInfo, collectData, collectMinimalData, compareChildsTargetWithCurrent, createTransformInstance, doCollectMinimalData, generateOutput, getAppContext, getContactInfo, getContainerServices, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getObjectSource, getResultFilterMode, getSession, getTargetBean, getTop, getType, getWebObjectsFactory, getWebObjectsFactory, getXMLStatus, hasChanged, hasTargetBeanChanged, haveChildrenChanged, initComponent, internalCollectData, isDialog, isForcedChildrenStateSaving, isIFrameRequest, isModal, isModalOpen, newDefaultBeanContext, newHiddenInputBuilder, newNamespaceEncoder, newStyleRequestContext, newURIBuilder, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setLeft, setOutputFormat, setTop

Methods inherited from class com.microstrategy.web.beans.AbstractWebComponent

addChild, addChildStateInfo, addChildStateInfo, addChildStateInfo, addStateInfo, childValues, clearChildren, clearStateCache, getCachedState, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, handleRequest, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isChangeComparisonFlagSet, isFeatureAvailable, newDefaultEventHandler, prepareForReuse, removeChild, removeChild, restoreState, restoreStateFromRequest, restoreStateFromRequest, saveXMLState, saveXMLState, saveXMLState, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setParent, setPersistMode, setRenderingFilter, setStateCache, setTargetBean, setTargetBeanPath, setWebEventHandler

Methods inherited from class com.microstrategy.web.beans.AbstractTransformable

addTransform, addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, createTransformInstance, getBeanContext, getDefaultTransform, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, hasTransform, hasTransform, internalCollectData, internalCollectData, invalidateTransformCache, isTransformSuitable, transform, transform, transform, transform

Methods inherited from class com.microstrategy.utils.serialization.AbstractPersistable

doFlatState, getStateHandler, isXMLStateZipped, restoreState, restoreXMLState, saveXMLState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getAncestors, getContents, getContents, getCurrentUnit, getLinks, getObjectCount, getSearchName, getTotalObjectCount

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

restoreState, restoreState

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

Constructor Detail

AbstractObjectExplorerBean

public AbstractObjectExplorerBean()

Method Detail

setTypeRestriction

public void setTypeRestriction(java.lang.String type)

Description copied from interface: ObjectExplorerBean

Sets a comma-separated String that represents the type of objects (from EnumDSSXMLObjectTypes) to display

Specified by:

setTypeRestriction in interface ObjectExplorerBean

Parameters:

type - a comma-separated String that represents the type of objects (from EnumDSSXMLObjectTypes) to display

See Also:

ObjectExplorerBean.setTypeRestriction(java.lang.String)

getTypeRestriction

public java.lang.String getTypeRestriction()

Specified by:

getTypeRestriction in interface ObjectExplorerBean

Returns:

a comma-separated String that represents the type of objects (from EnumDSSXMLObjectTypes) to display

See Also:

ObjectExplorerBean.getTypeRestriction()

getBlockBegin

public int getBlockBegin()

Specified by:

getBlockBegin in interface ObjectExplorerBean

Returns:

the first element on the block (used for incremental fetch)

See Also:

ObjectExplorerBean.getBlockBegin()

setBlockBegin

public void setBlockBegin(int blockBegin)

Description copied from interface: ObjectExplorerBean

Sets the first element on the block (used for incremental fetch)

Specified by:

setBlockBegin in interface ObjectExplorerBean

Parameters:

blockBegin - the first element on the block

See Also:

ObjectExplorerBean.setBlockBegin(int)

getBlockCount

public int getBlockCount()

Specified by:

getBlockCount in interface ObjectExplorerBean

Returns:

the total number of elements on the current block (used for incremental fetch)

See Also:

ObjectExplorerBean.getBlockCount()

setBlockCount

public void setBlockCount(int blockCount)

Description copied from interface: ObjectExplorerBean

Sets the total number of elements on the current block (used for incremental fetch)

Specified by:

setBlockCount in interface ObjectExplorerBean

Parameters:

blockCount - the total number of elements on the current block

See Also:

ObjectExplorerBean.setBlockCount(int)

setErrorMessage

public void setErrorMessage(java.lang.String message)

Specified by:

setErrorMessage in interface ObjectExplorerBean

Since:

MicroStrategy Web 9.0.0

getErrorMessage

public java.lang.String getErrorMessage()

Specified by:

getErrorMessage in interface ObjectExplorerBean

Since:

MicroStrategy Web 9.0.0