public class

HistoryListPageComponentImpl

extends AbstractPersistableAppComponent
implements PageComponent
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.HistoryListPageComponentImpl

Class Overview

Specialized implementation of the page component used for the "History List" page.

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.PageComponent
Fields
protected PageInfo _page
protected String _title
protected String _titleId
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
Public Constructors
HistoryListPageComponentImpl()
Public Methods
void cleanUp()
Performs any necessary clean up tasks before leaving the page.
void collectData()
Triggers execution to the back end no matter whether it is synchronous or asynchronous.
void collectMinimalData()
Triggers execution to the back end no matter whether it is synchronous or asynchronous.
boolean executeCollectDataRequiredAddons(WebComponent wc)
Checks if the different addons associated with the WebComponent require a collect data to be performed.
void executePostCollectDataAddons()
Executes the post collect data addons on the page in the order in which they appear in the pageconfig file.
void executePreCollectDataAddons()
Executes the addons on the page in the order in which they appear in the pageconfig file.
MarkupOutput generateOutput()
Generates the output of a bean.
ContextMenuManager getContextMenuManager()
This method is deprecated. This method is not used by the application and will be removed in future versions.
int getDebugFlags()
Get the decimal-format debug flags from the page
MarkupOutput getDebugOut(int debugFlags)
Get the Debug Information into the output
AppBeanError getErrorInfo()
Returns the last AppBeanError set to this page.
int getExplicitScreenMode()
WebFeatures getFeaturesManager()
Return the WebFeatures implementation associated with this WebComponent
String getFontName()
Returns a string with the name of the fonts, or the list of fonts that a browser should use when rendering the page.
String getFontSize()
A string with the base font size to use, the string might contain the type of size (i.e, pt, px, etc.)
int getLastMessageKey()
Read message key for active session.
String getLastMsgID()
String getPageHistoryKey()
PageInfo getPageInfo()
String getRedirectURL()
Returns the URL to be send down to the browser that corresponds to the page.
PageResourceManager getResourceManager()
Returns the instance of the PageResourceManager associated with the page.
int getResourceManagerMode()
Returns the mode of the page manager set up on the page component.
int getScreenMode()
Return the current page screen mode.
String getTemplateFileName()
Returns the name of a template file to redirect
TemplateInfo getTemplateInfo()
Convenience method.
String getTitle()
Returns the pages's title.
String getTitleDescriptorId()
WebIServerSession getWebIServerSession()
String getXMLStatusPageName()
Returns the name of the page in the Page Framework that will be displayed for the current page and xml status combination.
boolean hasBinaryContent()
boolean hasXMLStatusPage()
Returns true if a page in the Page Framework will be displayed for the current page and xml status combination.
boolean isOpen()
Returns a boolean value indicating if the instance is marked as opened or closed.
boolean isRedirect()
Indicates if the page will be sent down as a redirect response (HTTP 302) instead of an ok response (HTTP 200)
boolean isRestoredFromPageHistory()
boolean isStagePage()
Returns true if this page is just a stage page which acts as a bridge between two pages.
void persistBeans()
For each one of the beans defined, saves their State through the StateManager for future use in this page.
void processApplyChanges(String pageName)
The method will be responsible for executing the apply events to those beans that require to so, when the page is about to change
void saveLastPage()
Saves the information of the last succesful page so it can be restored by the cancel event.
void saveReturnToPage(int mode)
Saves the information of the last visited page so it can be restored by the returnTo event.
void setChanged(boolean value)
Sets the changed state of the component
void setErrorInfo(AppBeanError error)
Associates an AppBeanError with the page.
void setExplicitScreenMode(int screenMode)
Use to set the explicit screen mode.
void setIsRedirect(boolean redirect)
Sets the page as a redirect response (HTTP 302) instead of an ok response (HTTP 200)
void setPageInfo(PageInfo page)
This method sets the current Page (the object with the current Page structure)
void setRestoredFromPageHistory(boolean value)
void setScreenMode(int screenMode)
Set the screenMode of the page.
void setStagePage(boolean isStagePage)
Sets the page as a stage page which acts as a bridge between two pages.
void setTemplateFileName(String value)
Sets the name of a template file to redirect
void setTitle(String title)
Define the alias that the page will display when called.
void setWebIServerSession(WebIServerSession session)
This method is deprecated. The method does not have any effect in the object
void switchPage(String pageName, ServletWebComponent servletWebComponent)
Replaces the current page in the Servlet with the indicated page
Protected Methods
void doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)
Proceses the save/restore state opperation of the AppComponent
void doSaveToPageHistory()
Saves the page of to the page history regardless of the status or isTrack()
PageHistoryList getPageHistoryList()
WebEventHandler newDefaultEventHandler()
void saveToPageHistory()
Saves the information of the last visited page so it can be restored by open history list page event.
void setObjectBeanPageTitle(ObjectBean bean)
[Expand]
Inherited Methods
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.PageComponent
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Fields

protected PageInfo _page

protected String _title

protected String _titleId

Public Constructors

public HistoryListPageComponentImpl ()

Public Methods

public void cleanUp ()

Performs any necessary clean up tasks before leaving the page.
Called when event WebEventOpenHistoryPage is submited

public void collectData ()

Triggers execution to the back end no matter whether it is synchronous or asynchronous. This implementation also trigger the addons execution before and after the collect data.

public void collectMinimalData ()

Triggers execution to the back end no matter whether it is synchronous or asynchronous. If this method fails to collect data, an exception is raised and saved in a WebBeanError instance. If isOpen(), this method will first perform a doCollectMinimalData(), then proceeds to call collectMinimalData() on all child components getChild(int).

public boolean executeCollectDataRequiredAddons (WebComponent wc)

Checks if the different addons associated with the WebComponent require a collect data to be performed.

Parameters
wc WebComponent instance that will have its addon methods called
Returns
  • boolean value indicating if the collectData is required or not

public void executePostCollectDataAddons ()

Executes the post collect data addons on the page in the order in which they appear in the pageconfig file.

public void executePreCollectDataAddons ()

Executes the addons on the page in the order in which they appear in the pageconfig file.

public MarkupOutput generateOutput ()

Generates the output of a bean. It transforms the bean

Returns
  • Null for this component.

public ContextMenuManager getContextMenuManager ()

This method is deprecated.
This method is not used by the application and will be removed in future versions.

Returns
  • The Page's ContextMenuManager

public int getDebugFlags ()

Get the decimal-format debug flags from the page

public MarkupOutput getDebugOut (int debugFlags)

Get the Debug Information into the output

Returns

public AppBeanError getErrorInfo ()

Returns the last AppBeanError set to this page. If no errors have been associated to this page it returns null.

Returns
  • the AppBeanError associated with the execution of the page.

public int getExplicitScreenMode ()

public WebFeatures getFeaturesManager ()

Return the WebFeatures implementation associated with this WebComponent

Returns
  • a WebFeatures instance

public String getFontName ()

Returns a string with the name of the fonts, or the list of fonts that a browser should use when rendering the page. This is usually retrieved from user Preferences

Returns
  • a String with a comma separated list of the fonts to use in this page.

public String getFontSize ()

A string with the base font size to use, the string might contain the type of size (i.e, pt, px, etc.)

Returns
  • a string with size of the font to use

public int getLastMessageKey ()

Read message key for active session.

Returns
  • {int}

public String getLastMsgID ()

public String getPageHistoryKey ()

Returns
  • a key unique to the page used for the page history.

public PageInfo getPageInfo ()

Returns
  • the current Page (that holds the Page structure)

public String getRedirectURL ()

Returns the URL to be send down to the browser that corresponds to the page.

Returns
  • a URL String

public PageResourceManager getResourceManager ()

Returns the instance of the PageResourceManager associated with the page. Returns null if the resource manager is disabled.

Returns

public int getResourceManagerMode ()

Returns the mode of the page manager set up on the page component. The values are defined in the PageResourceManager class

Returns
  • positive integer when it is enabled.

public int getScreenMode ()

Return the current page screen mode.

Returns
  • page screen mode.

public String getTemplateFileName ()

Returns the name of a template file to redirect

Returns
  • a file name.

public TemplateInfo getTemplateInfo ()

Convenience method. Equivalent to calling: getPageInfo.getTemplateInfoList().getTemplateInfo(getXMLStatus())

Returns
  • the current templateinfo to be used by this page

public String getTitle ()

Returns the pages's title. This method dynamically sets the title of the page, depending on:

  1. If the user has set title using the setTitle(String) method, that title is used.
  2. If the first child of the page is of any of the expected types, the title is used based on the bean.
  3. If the PageInfo contains a desc-id, the resource associated with the desc-id is used
  4. If the PageInfo contains a description, the description is used
  5. The name of the page.
      The expected bean types are:
      • ReportFrameBean: the objectName of the associated ReportBean is used. The title will depend as well in the status of the bean (i.e., if it's processing the name is prefixed with Executing ()
      • DocumentFrameBean: the objectName of the associated DocumentBean is used. The title will depend as well in the status of the bean
      • ObjectBean: it's object name
      • PreferencesBean: the name of the current group set.

Returns
  • The title of this page

public String getTitleDescriptorId ()

public WebIServerSession getWebIServerSession ()

Returns
  • The WebIServerSession used by this page. If this page is not using a session, it returns null;

public String getXMLStatusPageName ()

Returns the name of the page in the Page Framework that will be displayed for the current page and xml status combination. This is defined at the template level in the pageConfig.xml file

Returns
  • String. Page Name from pageConfig.xml

public boolean hasBinaryContent ()

Returns
  • true if the page would generate binary content in it's output

public boolean hasXMLStatusPage ()

Returns true if a page in the Page Framework will be displayed for the current page and xml status combination. This is defined at the template level in the pageConfig.xml file

Returns
  • true is a page Name has been defined in pageConfig.xml

public boolean isOpen ()

Returns a boolean value indicating if the instance is marked as opened or closed.

Returns
  • boolean value of True if the instance is marked as opened, it will return False otherwise. By default, instances not marked as dialogs (isDialog() property returning False) will have a browser setting associated with them that should indicate if they are opened or closed. The parent hierarchy is also tested to be in opened state as well as dependent beans not to be in error.
See Also

public boolean isRedirect ()

Indicates if the page will be sent down as a redirect response (HTTP 302) instead of an ok response (HTTP 200)

Returns
  • boolean value indicating if the the page will be displayed as a redirect (HTTP 302) response

public boolean isRestoredFromPageHistory ()

public boolean isStagePage ()

Returns true if this page is just a stage page which acts as a bridge between two pages.

Returns
  • true is this page is a stage page.

public void persistBeans ()

For each one of the beans defined, saves their State through the StateManager for future use in this page.

public void processApplyChanges (String pageName)

The method will be responsible for executing the apply events to those beans that require to so, when the page is about to change

Parameters
pageName The name of the new page
Throws
WebException
WebException

public void saveLastPage ()

Saves the information of the last succesful page so it can be restored by the cancel event.

public void saveReturnToPage (int mode)

Saves the information of the last visited page so it can be restored by the returnTo event.

Parameters
mode int value indicating the type of action that should be performed about the return to page information. Values includeSTORE_PAGE and REMOVE_PAGE.

public void setChanged (boolean value)

Sets the changed state of the component

Parameters
value a boolean value indicating whether the component is changed.

public void setErrorInfo (AppBeanError error)

Associates an AppBeanError with the page. If an error occurred during the page initialization/execution, this error should be set. It's responsibility of the display later (i.e., the JSP) to display this error to the end user.

Parameters
error The last error on this page. null if none happened

public void setExplicitScreenMode (int screenMode)

Use to set the explicit screen mode.

public void setIsRedirect (boolean redirect)

Sets the page as a redirect response (HTTP 302) instead of an ok response (HTTP 200)

Parameters
redirect boolean value indicating if the the page will be displayed as a redirect (HTTP 302) response

public void setPageInfo (PageInfo page)

This method sets the current Page (the object with the current Page structure)

Parameters
page Page object

public void setRestoredFromPageHistory (boolean value)

public void setScreenMode (int screenMode)

Set the screenMode of the page. Screen mode can be normal screen mode (screenMode = 1), full screen mode (screenMode = 2), or default to normal screen mode (screenMode = 0).

public void setStagePage (boolean isStagePage)

Sets the page as a stage page which acts as a bridge between two pages.

Parameters
isStagePage boolean value indicating if the the page is a stagePage.

public void setTemplateFileName (String value)

Sets the name of a template file to redirect

Parameters
value String value indicating the template file name to use.

public void setTitle (String title)

Define the alias that the page will display when called.

Parameters
title String with the title of the page. User setTitle

public void setWebIServerSession (WebIServerSession session)

This method is deprecated.
The method does not have any effect in the object

Parameters
session The WebIServerSession to be used by this page.

public void switchPage (String pageName, ServletWebComponent servletWebComponent)

Replaces the current page in the Servlet with the indicated page

Protected Methods

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

Proceses the save/restore state opperation of the AppComponent

Parameters
serializer an instance of the FlatStateSerializer object to use
howMuchState defines how much information needs to be saved
tokenizer an instance of the FlatStateTokenizer object to use

protected void doSaveToPageHistory ()

Saves the page of to the page history regardless of the status or isTrack()

protected PageHistoryList getPageHistoryList ()

Returns
  • the page history list object

protected WebEventHandler newDefaultEventHandler ()

protected void saveToPageHistory ()

Saves the information of the last visited page so it can be restored by open history list page event.
Uses the page's status and the pages isTrack() to determine whether to save the page

protected void setObjectBeanPageTitle (ObjectBean bean)