public abstract class

AbstractObjectBrowserTabBean

extends AbstractViewBeanParserBean
implements ObjectBrowserTabBean TabBean
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.AbstractViewBeanParserBean
                 ↳ com.microstrategy.web.app.beans.AbstractObjectBrowserTabBean

Class Overview

Abstract implementation of the ObjectBrowserTabBean interface. This abstract class can be used for customizations, inheriting the basic definition of the methods available for these instances.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.ObjectBrowserTabBean
From interface com.microstrategy.web.app.beans.TabBean
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
Public Constructors
AbstractObjectBrowserTabBean()
Default constructor.
Public Methods
void addChildStateInfo(ParameterBuilder paramBldr, int howMuchState)
Adds children state information into an existing ParameterBuilder instance.
int getDesignModeStage()
Get the stage of the design mode (EnumReportDesignMode).
String getEnabledCmdId()
Get the command id to be queried on the clioent site.
String getFeatures()
Gets a list of feature ids that are required to enable the tab
String getHelpTopic()
get the help topic of this tab
String getHelpType()
get the type of the help file
int[] getObjectFilter(int targetMode)
Get an array of object subtypes to use for filtering when a search is run.
int[] getObjectFilter()
Get an array of object subtypes to use for filtering when a search is run.
boolean getRequireSingleSelector()
Each instance of this class represents a tab in the TabManagerBean.
String getSupportedTypes()
Get the list of objects this tab can be associated with.
int getSwitchMode()
the switching mode can be: CACHED - use the cached tab content on the client side FETCH - go back to the webserver to fetch the tab content
String getTabId()
Returns a string can be used as the identifier of the tab.
String getTabLabel()
Get the description text to be used as title for the display of the tab.
String getTabLabelId()
Get the identifier of the descriptor to be used as title for the display of the tab.
TabManagerBean getTabManager()
Utility method for obtaining the parent tabe manager associated to this tab
String getTabName()
Each instance of this class represents a tab in the TabManagerBean.
int getTabRepresented()
Each instance of this class represents a tab in the TabManagerBean.
int getXMLStatus()
Returns the EnumRequestStatus status of the component.
boolean isAvailable()
This method specifies if in the current scenario, the bean instance can be displayed as possible tab option, based on granted privileges, etc.
boolean isEditor()
Indicates whether the instance most be considered editor.
boolean isPartialUpdate()
boolean isTargetingFilter()
Returns if the object browser is targeting the filter or not
void setDesignModeStage(int designModeStage)
Holds the stage of the design mode (EnumReportDesignMode) .
void setEnabledCmdId(String value)
Set the command id to be queried on the client site.
void setFeatures(String featureIds)
Sets a list of feature ids that are required to enable the tab
void setHelpTopic(String topic)
Set the help topic of the editor
void setHelpType(String type)
set the help type for the editor
void setName(String name)
Sets the name for the current component.
void setObjectFilter(String objectFilter)
Set the filter to use when obtaining the contents to display.
void setPartialUpdate(boolean partialUpdate)
void setRequireSingleSelector(boolean requireSingleSelector)
Each instance of this class represents a tab in the TabManagerBean.
void setSupportedTypes(String supportedTYpes)
Set the list of objects this tab can be associated with.
void setSwitchMode(int switchMode)
the switching mode can be: CACHED - use the cached tab content on the client side FETCH - go back to the webserver to fetch the tab content
void setTabLabel(String description)
Set the description text to be used as title for the display of the tab.
void setTabLabelId(String descriptionId)
Set the identifier of the descriptor to be used as title for the display of the tab.
void setTabName(String tabName)
Each instance of this class represents a tab in the TabManagerBean.
void setTabRepresented(int tabRepresented)
Each instance of this class represents a tab in the TabManagerBean.
Protected Methods
void doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)
Speciefies which bean's properties are persisted.
WebEventHandler newDefaultEventHandler()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.beans.AbstractViewBeanParserBean
From class com.microstrategy.web.app.beans.AbstractPersistableFrameElement
From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
From class com.microstrategy.web.app.beans.AbstractAppComponent
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.ObjectBrowserTabBean
From interface com.microstrategy.web.app.beans.TabBean
From interface com.microstrategy.web.app.beans.ViewBeanParserBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Constructors

public AbstractObjectBrowserTabBean ()

Default constructor. No arguments.

Public Methods

public void addChildStateInfo (ParameterBuilder paramBldr, int howMuchState)

Adds children state information into an existing ParameterBuilder instance. It is up to the supplied ParameterBuilder to determine how this information is serialized.

Parameters
paramBldr The ParameterBuilder instance which has child state information added to it.
howMuchState How much state is added. (see EnumWebPersistableState for details).

public int getDesignModeStage ()

Get the stage of the design mode (EnumReportDesignMode).

Returns
  • int

public String getEnabledCmdId ()

Get the command id to be queried on the clioent site. This determines the availability of the tab.

Returns
  • String with the tab's command id.

public String getFeatures ()

Gets a list of feature ids that are required to enable the tab

Returns
  • String

public String getHelpTopic ()

get the help topic of this tab

Returns
  • the help topic of this tab needs to point to

public String getHelpType ()

get the type of the help file

Returns

public 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 int[] getObjectFilter ()

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

Returns

public boolean getRequireSingleSelector ()

Each instance of this class represents a tab in the TabManagerBean. This method inidicates whether this tab instance's availability relies on the selection of exactly one selector control among all the units the user has selected.

Returns
  • indicates whether a single selection on selector control is required for the tab to be available or not.

public String getSupportedTypes ()

Get the list of objects this tab can be associated with.

Returns
  • String with the a list of supported objects.

public int getSwitchMode ()

the switching mode can be: CACHED - use the cached tab content on the client side FETCH - go back to the webserver to fetch the tab content

Returns
  • the switching mode of this tab instance uses

public String getTabId ()

Returns a string can be used as the identifier of the tab.

Returns
  • String with the text to be used as the id of the tab.
See Also

public String getTabLabel ()

Get the description text to be used as title for the display of the tab.

Returns
  • String with the text to be used as title of the tab.

public String getTabLabelId ()

Get the identifier of the descriptor to be used as title for the display of the tab.

Returns
  • String with the identifier of the descriptor to be used as title of the tab.

public TabManagerBean getTabManager ()

Utility method for obtaining the parent tabe manager associated to this tab

Returns

public String getTabName ()

Each instance of this class represents a tab in the TabManagerBean. This method allows an alternative other than getTabRepresented() to get which tab this instance presents , so the TabManagerBean manager knows how to transfer render control to the child, depending on which tab name the user requested.

Returns
  • the name identifier of the tab this instance represents

public int getTabRepresented ()

Each instance of this class represents a tab in the TabManagerBean. This method allows to get which tab this instance will represent, so the TabManagerBean manager knows how to transfer render control to the child, depending on which tab the user requested.

Returns
  • the identifier of the tab this instance represents

public int getXMLStatus ()

Returns the EnumRequestStatus status of the component. The status determined by by the status of its children with the following precedence.

  • WebBeanRequestEndsInError
  • WebBeanRequestCanceled
  • WebBeanRequestProcessing
  • WebBeanRequestNotInitiated
  • WebBeanRequestWaitingForUserInput
  • WebBeanRequestSuccessful

  • Returns
    See Also

    public boolean isAvailable ()

    This method specifies if in the current scenario, the bean instance can be displayed as possible tab option, based on granted privileges, etc.

    Returns
    • True if the instance is available for being displayed, if the user were to request it. Returns False otherwise.
    See Also

    public boolean isEditor ()

    Indicates whether the instance most be considered editor.

    Returns
    • True.

    public boolean isPartialUpdate ()

    public 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 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 void setEnabledCmdId (String value)

    Set the command id to be queried on the client site. This determines the availability of the tab.

    public void setFeatures (String featureIds)

    Sets a list of feature ids that are required to enable the tab

    Parameters
    featureIds String featureIds separated by ","

    public void setHelpTopic (String topic)

    Set the help topic of the editor

    Parameters
    topic the help topic

    public void setHelpType (String type)

    set the help type for the editor

    Parameters
    type String is one of HELP_TYPE_ADMIN,HELP_TYPE_USER,HELP_TYPE_CUSTOM

    public void setName (String name)

    Sets the name for the current component.

    Parameters
    name the name of the current component.
    See Also

    public 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

    public void setPartialUpdate (boolean partialUpdate)

    public void setRequireSingleSelector (boolean requireSingleSelector)

    Each instance of this class represents a tab in the TabManagerBean. This method allows to specify whether this tab instance's availability relies on the selection of exactly one selector control among all the units the user has selected.

    Parameters
    requireSingleSelector boolean indicating whether a single selection on selector control is required for the tab to be available or not.

    public void setSupportedTypes (String supportedTYpes)

    Set the list of objects this tab can be associated with.

    Parameters
    supportedTYpes String list of the associated objectys i.e. obj.103, obj.102

    public void setSwitchMode (int switchMode)

    the switching mode can be: CACHED - use the cached tab content on the client side FETCH - go back to the webserver to fetch the tab content

    Parameters
    switchMode the switching mode to set for this tab instance

    public void setTabLabel (String description)

    Set the description text to be used as title for the display of the tab.

    Parameters
    description String with the text to be used as title of the tab.

    public void setTabLabelId (String descriptionId)

    Set the identifier of the descriptor to be used as title for the display of the tab.

    Parameters
    descriptionId String with the identifier of the descriptor to be used as title of the tab.

    public void setTabName (String tabName)

    Each instance of this class represents a tab in the TabManagerBean. This method allows an alternative other than getTabRepresented() to get which tab this instance presents , so the TabManagerBean manager knows how to transfer render control to the child, depending on which tab name the user requested.

    Parameters
    tabName the name identifier of the tab this instance represents

    public void setTabRepresented (int tabRepresented)

    Each instance of this class represents a tab in the TabManagerBean. This method allows to specify which tab this instance will represent, so the TabManagerBean manager knows how to transfer render control to the child, depending on which tab the user requested.

    Parameters
    tabRepresented an identifier of the tab this instance represents.

    Protected Methods

    protected void doFlatState (FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)

    Speciefies which bean's properties are persisted.

    Parameters
    serializer FlatStateSerializer initialized instance where the state of the instance is handled
    howMuchState int value from EnumWebPersistableState indicating how much state should be handled by this instance
    tokenizer FlatStateTokenizer initialized instance where the state of the instance is handled.

    protected WebEventHandler newDefaultEventHandler ()