Package com.microstrategy.web.beans

Interface RequestPersistable

All Superinterfaces:

EnumWebPersistableState, Persistable

All Known Subinterfaces:

AddressListBean, AlertsEditorBean, AnnotationBean, AppSchemaBean, AssociatedSchedulesBean, AttributeBean, AttributeFormsEditorBean, AttributeFormsQualificationBean, ChangePasswordBean, ColorGradientEditorBean, ColorPickerEditorBean, ConstantPromptBean, ContactsBrowserBean, ControlToolbarBean, CustomGroupBean, DataExplorerBean, DerivedElementBean, DerivedElementFormatEditorBean, DerivedElementsEditorBean, DiagnosticsBean, DimtyPromptBean, DocumentBean, DocumentFrameBean, DocumentFrameElement, DrillEditorBean, DrillFilterEditorBean, EditableObjectAppBean, EditableObjectBean, ElementPromptBean, ExportBean, ExportOptionsEditorBean, ExpressionBean, ExpressionDisplayBean, ExpressionPromptBean, FilterAppBean, FilterBean, FilterEditorBean, FilterElementBean, FilterFrameBean, FolderBean, FormatTabManagerBean, FormatToolbarBean, FormulaBarBean, FrameBean, FrameElement, GraphBean, GraphColorGradientEditorBean, GraphFormatEditorBean, GraphFormatToolbarBean, GridColorGradientEditorBean, GridFormatBean, GridFormatEditorBean, GridFormatToolbarBean, GroupPathBean, ImportWizardBean, InboxBean, LimitExpressionBean, LoginBean, ObjectBean, ObjectBrowserBean, ObjectBrowserManagerBean, ObjectPromptBean, ObjectSelectionBean, OptionsBean, PageByBean, PageSetupHTMLEditorBean, PerformanceMonitorBean, PreferencesBean, ProjectBrowser, PromptAnswerBean, PromptAppBean, PromptBean, PromptConstantAppBean, PromptDefinitionAppBean, PromptDefinitionBean, PromptDimtyAppBean, PromptElementsAppBean, PromptExpressionAppBean, PromptHierarchyAppBean, PromptObject, PromptObjectAppBean, PromptsBean, ReportBean, ReportFrameBean, ReportFrameElement, ResizeEditorBean, ResultSetBean, RWActionControlEditorBean, RWBean, RWDColorGradientEditorBean, RWFrameBean, RWViewBean, RWViewExpressionBean, SaveAsBean, ScheduleBean, SearchBean, SecondaryDataSourcesEditorBean, SecurityFilterBean, SecurityRoleBean, SecurityRoleUserEntitiesSelectorBean, SortEditorBean, SubscriptionBean, SubscriptionContactsBrowserBean, SubscriptionEditorBean, SubscriptionFolderBean, SubsetUnitLimitBean, SubsetUnitLimitElementBean, SubtotalsEditorBean, TabManagerBean, ThresholdEditorBean, ThresholdExpressionBean, ToolbarBean, ToolbarSetBean, UserBean, UserContactsBrowserBean, UserEntitiesBean, UserEntitiesBrowserBean, UserEntitiesSelectorBean, UserEntityBean, UserGroupBean, UserSearchBean, ViewBean, ViewFilterElementPanelBean, VisualizationPropertiesEditorBean, VisualizationsEditorBean, WebAppSessionManager, WebBean, WebSessionManager, WizardBean

All Known Implementing Classes:

AbstractColorGradientEditorBeanImpl, AbstractFrameEditorBean, AbstractLimitExpressionBean, AbstractObjectBrowserTabBean, AbstractObjectExplorerBean, AbstractPersistableAppComponent, AbstractPersistableFrameElement, AbstractTemplateElementsBean, AbstractViewBeanParserBean, AccordionTabManagerBeanImpl, AllObjectBrowserBeanImpl, AssociatedSchedulesBeanImpl, AttributeFormsQualificationBeanImpl, ColorGradientEditorBeanImpl, ControlToolbarBeanImpl, CSRFConfirmationPageComponentImpl, DatasetObjectExplorerBeanImpl, DerivedElementBeanImpl, DerivedElementsBrowserBeanImpl, DesktopPageComponentImpl, DocumentPageComponentImpl, DrillEditorBeanImpl, EditPromptPageComponentImpl, ElementPickerBeanImpl, FilterDetailsFormattingEditorBeanImpl, FolderObjectExplorerBeanImpl, FolderPageComponentImpl, GraphColorGradientEditorBeanImpl, GraphTitleTabBeanImpl, GridColorGradientEditorBeanImpl, HistoryListPageComponentImpl, IOSSmartBannerBeanImpl, MySubscriptionsPageComponentImpl, NewWindowPageComponentImpl, OptimizedTabBeanImpl, OptionsBeanImpl, PageSetupHTMLEditorBeanImpl, PageSubscriptionsEdit, PathBeanImpl, PreferencesBeanImpl, PreferenceSettingPageComponentImpl, PreferencesPageComponentImpl, ProjectBrowserBeanImpl, PromptDetailsBeanImpl, ReportDetailsBeanImpl, ReportFrameBeanImpl, ReportPageComponentImpl, ResultSetPageComponentImpl, RibbonBeanImpl, RWDColorGradientEditorBeanImpl, RWGraphDropZonesEditorBeanImpl, RWOIVMPageComponent, RWPageComponentImpl, RWPromptsPageComponent, RWSaveAsPageComponentImpl, SearchPageComponentImpl, SecondaryDataSourcesEditorBeanImpl, SecurityRoleUserEntitiesSelectorBeanImpl, ServerAdminSessionManager, ServletWebComponent, SharingConfirmationPageComponentImpl, SimplePageComponentImpl, ThresholdExpressionBeanImpl, ViewFilterElementPanelBeanImpl, VisualizationPropertiesEditorBeanImpl, VisualizationsEditorBeanImpl, WebAppSessionManagerImpl, WebSessionManagerImpl, XDADataExplorerBeanImpl

public interface RequestPersistable
extends Persistable

This interface provides extra functionalities that allow restoration of state from a RequestKeys object.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

Modifier and Type	Method	Description
boolean	restoreStateFromRequest(RequestKeys rk)	Restores a WebComponent based on the RequestKeys instance.
boolean	restoreStateFromRequest(RequestKeys rk, java.lang.String keyName)	Restores a WebComponent based on the RequestKeys instance.

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Method Detail

restoreStateFromRequest

boolean restoreStateFromRequest(RequestKeys rk)

Restores a WebComponent based on the RequestKeys instance. This method retrieves the saved state of a component based on the component's name.

Parameters:

rk - a RequestKeys instance.

Returns:

true if restoration succeeds.

restoreStateFromRequest

boolean restoreStateFromRequest(RequestKeys rk,
                                java.lang.String keyName)

Restores a WebComponent based on the RequestKeys instance. This method retrieves the saved state of a component based on the parameter keyName.

Parameters:

rk - a RequestKeys instance.

keyName - the key to the state of a component.

Returns:

true if restoration succeeds.