public interface

ObjectBrowserTabBean

implements TabBean
com.microstrategy.web.app.beans.ObjectBrowserTabBean
Known Indirect Subclasses

Class Overview

This interface shall be used as base for creating tab beans that can be displayed by a ObjectBrowserManagerBean instance or on their own, showing features related with project and object browsing.

Summary

Constants
int CONTENTS_TYPE_RWDATAELEMENTS Constant that indicates the object of the contents this instance will generate is an instance of RWDataSets
int CONTENTS_TYPE_WEBFOLDER Constant that indicates the object of the contents this instance will generate is an instance of WebFolder
int CONTENTS_TYPE_WEB_WORKING_SET Constant that indicates the object of the contents this instance will generate is an instance of WebWorkingSet
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.TabBean
Public Methods
abstract Object getContents()
Get an instance with the contents to be rendered on the tab
abstract int getContentsType()
This method allows users of this interface to know the type of output to expect from the getContents() method, since for example, in some cases, it might be a WebFolder instance (when returning searches, folder browsing or report working set information) or a RWDataSets instance (when returning data element information from a report writing bean)
abstract int getDesignModeStage()
Get the stage of the design mode (EnumReportDesignMode).
abstract int[] getObjectFilter()
Get an array of object subtypes to use for filtering when a search is run.
abstract int[] getObjectFilter(int targetMode)
Get an array of object subtypes to use for filtering when a search is run.
abstract boolean isTargetingFilter()
Returns if the object browser is targeting the filter or not
abstract void prepareTabContentsList()
Prepare the list of contents this tab will get displayed to the user.
abstract void setDesignModeStage(int designModeStage)
Holds the stage of the design mode (EnumReportDesignMode) .
abstract void setObjectFilter(String objectFilter)
Set the filter to use when obtaining the contents to display.
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.TabBean
From interface com.microstrategy.web.app.beans.ViewBeanParserBean
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final int CONTENTS_TYPE_RWDATAELEMENTS

Constant that indicates the object of the contents this instance will generate is an instance of RWDataSets

Constant Value: 2 (0x00000002)

public static final int CONTENTS_TYPE_WEBFOLDER

Constant that indicates the object of the contents this instance will generate is an instance of WebFolder

Constant Value: 1 (0x00000001)

public static final int CONTENTS_TYPE_WEB_WORKING_SET

Constant that indicates the object of the contents this instance will generate is an instance of WebWorkingSet

Constant Value: 3 (0x00000003)

Public Methods

public abstract Object getContents ()

Get an instance with the contents to be rendered on the tab

Returns
  • an Object instance with the objects that should be rendered as part of the tab information for the Object Browser. For determining the type of instance this object is, the getContentsType() method can be called.

public abstract int getContentsType ()

This method allows users of this interface to know the type of output to expect from the getContents() method, since for example, in some cases, it might be a WebFolder instance (when returning searches, folder browsing or report working set information) or a RWDataSets instance (when returning data element information from a report writing bean)

Returns

public abstract int getDesignModeStage ()

Get the stage of the design mode (EnumReportDesignMode).

Returns
  • int

public abstract int[] getObjectFilter ()

Get an array of object subtypes to use for filtering when a search is run.

Returns

public abstract int[] getObjectFilter (int targetMode)

Get an array of object subtypes to use for filtering when a search is run.

Parameters
targetMode the target mode indicated for selecting the filter defined for it. For example, ObjectBrowserTargetReport
Returns
  • an array of int values representing the filter to use corresponding to the target mode specified.

public abstract boolean isTargetingFilter ()

Returns if the object browser is targeting the filter or not

Returns
  • True if the user is editing the report filter, False otherwise

public abstract void prepareTabContentsList ()

Prepare the list of contents this tab will get displayed to the user. These contents will later on be available to users via the getContents() method.

public abstract void setDesignModeStage (int designModeStage)

Holds the stage of the design mode (EnumReportDesignMode) . The report frame bean will be responsible for setting this property of the objectbrowser tab beans.

public abstract void setObjectFilter (String objectFilter)

Set the filter to use when obtaining the contents to display. A default object filter specification is defined, but it can be overwritten when using this method. The filter specified here will be applicable only when a search is run for retrieving the information to render to the user.

Parameters
objectFilter a String specifying the object filter to use, with the following format:
targetMode1:objectSubtype1,objectSubtype2,objectSubtype3;targetMode2:objectSubtype2
Where the target mode is specified on the parent ObjectBrowserManagerBean instance.
If no target is specified, then it means that regardless of the target mode, it will use the list of object subtypes specified as filter. For example:
objectSubtype1,objectSubtype2,objectSubtype3