Package com.microstrategy.web.app.beans

Interface ObjectExplorerBean

All Superinterfaces:

AppComponent, Transformable, WebComponent

All Known Subinterfaces:

AllObjectBrowserBean, DatasetObjectExplorerBean, DerivedElementsBrowserBean, FolderObjectExplorerBean, ImportDerivedElementsBean, ObjectManipulationDialogBean, SaveAsBean, XDADataExplorerBean

All Known Implementing Classes:

AbstractObjectExplorerBean, AllObjectBrowserBeanImpl, DatasetObjectExplorerBeanImpl, DerivedElementsBrowserBeanImpl, FolderObjectExplorerBeanImpl, XDADataExplorerBeanImpl

public interface ObjectExplorerBean
extends AppComponent

Bean that represents an editor designed for object browsing.
Its contents are based on the current object, which may be a folder or search results

Since:

MicroStrategy Web 8.0.2

Field Summary

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

COMPONENT_POSITION_NOT_INITIALIZED

Method Summary

Modifier and Type	Method	Description
java.util.ArrayList	getAncestors()
int	getBlockBegin()
int	getBlockCount()
java.util.ArrayList	getContents()
java.util.ArrayList	getContents(boolean sortAscending)
WebDisplayUnit	getCurrentUnit()
java.lang.String	getErrorMessage()
java.util.ArrayList	getLinks()
int	getObjectCount()
java.lang.String	getSearchName()
int	getTotalObjectCount()
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 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.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

Method Detail

getAncestors

java.util.ArrayList getAncestors()

Returns:

an List of WebDisplayUnit objects containing the list of of the current object's ancestors (parent folders)

getContents

java.util.ArrayList getContents()

Returns:

an List of WebDisplayUnit objects that represent the objects contained inside the current object (folder). The type of objects can be specified using the typeRestriction property

getContents

java.util.ArrayList getContents(boolean sortAscending)

Parameters:

sortAscending - specifies if the results should be sorted ascending or descending.

Returns:

an List of WebDisplayUnit objects that represent the objects contained inside the current object (folder). The type of objects can be specified using the typeRestriction property

getLinks

java.util.ArrayList getLinks()

Returns:

an List of WebDisplayUnit objects that represent the project links.

getTotalObjectCount

int getTotalObjectCount()

Returns:

the total number of objects contained in the current object

getObjectCount

int getObjectCount()

Returns:

the number of objects contained in the object's current block.

getCurrentUnit

WebDisplayUnit getCurrentUnit()

Returns:

a WebDisplayUnit that represents the current object

getBlockBegin

int getBlockBegin()

Returns:

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

setBlockBegin

void setBlockBegin(int blockBegin)

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

Parameters:

blockBegin - the first element on the block

getBlockCount

int getBlockCount()

Returns:

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

setBlockCount

void setBlockCount(int blockCount)

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

Parameters:

blockCount - the total number of elements on the current block

setTypeRestriction

void setTypeRestriction(java.lang.String type)

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

Parameters:

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

getTypeRestriction

java.lang.String getTypeRestriction()

Returns:

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

getSearchName

java.lang.String getSearchName()

Returns:

The current search name if any.

setErrorMessage

void setErrorMessage(java.lang.String message)

Since:

MicroStrategy Web 9.0.0

getErrorMessage

java.lang.String getErrorMessage()

Since:

MicroStrategy Web 9.0.0