public interface

ObjectExplorerBean

implements AppComponent
com.microstrategy.web.app.beans.ObjectExplorerBean
Known Indirect Subclasses

Class Overview

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

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract ArrayList getAncestors()
abstract int getBlockBegin()
abstract int getBlockCount()
abstract ArrayList getContents()
abstract ArrayList getContents(boolean sortAscending)
abstract WebDisplayUnit getCurrentUnit()
abstract String getErrorMessage()
abstract ArrayList getLinks()
abstract int getObjectCount()
abstract String getSearchName()
abstract int getTotalObjectCount()
abstract String getTypeRestriction()
abstract void setBlockBegin(int blockBegin)
Sets the first element on the block (used for incremental fetch)
abstract void setBlockCount(int blockCount)
Sets the total number of elements on the current block (used for incremental fetch)
abstract void setErrorMessage(String message)
abstract void setTypeRestriction(String type)
Sets a comma-separated String that represents the type of objects (from EnumDSSXMLObjectTypes) to display
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract ArrayList getAncestors ()

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

public abstract int getBlockBegin ()

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

public abstract int getBlockCount ()

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

public abstract 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

public abstract 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

public abstract WebDisplayUnit getCurrentUnit ()

Returns

public abstract String getErrorMessage ()

public abstract ArrayList getLinks ()

Returns

public abstract int getObjectCount ()

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

public abstract String getSearchName ()

Returns
  • The current search name if any.

public abstract int getTotalObjectCount ()

Returns
  • the total number of objects contained in the current object

public abstract String getTypeRestriction ()

Returns

public abstract void setBlockBegin (int blockBegin)

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

Parameters
blockBegin the first element on the block

public abstract 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

public abstract void setErrorMessage (String message)

public abstract void setTypeRestriction (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