Package com.microstrategy.utils.serialization

Interface Persistable

All Superinterfaces:

EnumWebPersistableState

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, PromptsContainerBean, ReportBean, ReportFrameBean, ReportFrameElement, RequestPersistable, ResizeEditorBean, ResultSetBean, RWActionControlEditorBean, RWBean, RWDColorGradientEditorBean, RWFrameBean, RWInstance, RWViewBean, RWViewExpressionBean, SaveAsBean, ScheduleBean, SearchBean, SecondaryDataSourcesEditorBean, SecurityFilterBean, SecurityRoleBean, SecurityRoleUserEntitiesSelectorBean, ServerMachine, 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, WebBrowsePath, WebChangeJournalSearch, WebConstantPrompt, WebConstantPromptAnswer, WebCustomGroup, WebDerivedElement, WebDimtyPrompt, WebDimtyPromptAnswer, WebDocumentInstance, WebElementsPrompt, WebElementsPromptAnswer, WebExpressionPrompt, WebExpressionPromptAnswer, WebFilter, WebFilterBase, WebIServerSession, WebIServerSessionList, WebIServerSubscriptionDevice, WebIServerSubscriptionTrigger, WebLocale, WebLocalizationManager, WebMDSecurityFilter, WebMonitor, WebObjectsPrompt, WebObjectsPromptAnswer, WebPerformanceMonitor, WebPrompt, WebPromptAnswer, WebReportInstance, WebResultSetInstance, WebReusableThresholds, WebSchedule, WebSearch, WebSecurityRole, WebSessionInfo, WebSessionInfoList, WebSessionManager, WebSubscription, WebSubscriptionAddress, WebSubscriptionAnswer, WebSubscriptionComponent, WebSubscriptionContact, WebSubscriptionContent, WebSubscriptionContentDocument, WebSubscriptionContentFormat, WebSubscriptionContentReport, WebSubscriptionDeliveryModeCacheProperties, WebSubscriptionDeliveryModeEmailProperties, WebSubscriptionDeliveryModeFileProperties, WebSubscriptionDeliveryModeFTPProperties, WebSubscriptionDeliveryModeHistoryListProperties, WebSubscriptionDeliveryModeMobileProperties, WebSubscriptionDeliveryModePrintProperties, WebSubscriptionDeliveryModeProperties, WebSubscriptionDevice, WebSubscriptionDeviceLocation, WebSubscriptionDynamicRecipientList, WebSubscriptionTrigger, WebSubscriptionUserAddresses, WebThresholds, WebTimePrompt, WebUser, WebUserEntity, WebUserGroup, WebUserSearch, WizardBean, WizardStepBean

All Known Implementing Classes:

AbstractAppComponent, AbstractColorGradientEditorBeanImpl, AbstractFrameEditorBean, AbstractLimitExpressionBean, AbstractObjectBrowserTabBean, AbstractObjectExplorerBean, AbstractPersistable, AbstractPersistableAppComponent, AbstractPersistableFrameElement, AbstractTemplateElementsBean, AbstractTransformable, AbstractViewBeanParserBean, AbstractWebComponent, AccordionTabManagerBeanImpl, AllObjectBrowserBeanImpl, AssociatedSchedulesBeanImpl, AttributeFormsQualificationBeanImpl, ColorGradientEditorBeanImpl, ControlToolbarBeanImpl, CreditsBean, CSRFConfirmationPageComponentImpl, DatasetObjectExplorerBeanImpl, DerivedElementBeanImpl, DerivedElementsBrowserBeanImpl, DesktopPageComponentImpl, DocumentPageComponentImpl, DrillEditorBeanImpl, EditPromptPageComponentImpl, ElementPickerBeanImpl, FilterDetailsFormattingEditorBeanImpl, FolderObjectExplorerBeanImpl, FolderPageComponentImpl, GraphColorGradientEditorBeanImpl, GraphTitleTabBeanImpl, GridColorGradientEditorBeanImpl, HistoryListPageComponentImpl, IOSSmartBannerBeanImpl, MySubscriptionsPageComponentImpl, NewWindowPageComponentImpl, OptimizedTabBeanImpl, OptionsBeanImpl, PageHistoryItem, PageHistoryList, PageSetupHTMLEditorBeanImpl, PageSubscriptionsEdit, PathBeanImpl, PersistableAdapter, PreferencesBeanImpl, PreferenceSettingPageComponentImpl, PreferencesPageComponentImpl, ProjectBrowserBeanImpl, ProjectInfoPersister, PromptDetailsBeanImpl, ReportDetailsBeanImpl, ReportFrameBeanImpl, ReportPageComponentImpl, ResultSetPageComponentImpl, RibbonBeanImpl, RWDColorGradientEditorBeanImpl, RWGraphDropZonesEditorBeanImpl, RWOIVMPageComponent, RWPageComponentImpl, RWPromptsPageComponent, RWSaveAsPageComponentImpl, SearchPageComponentImpl, SecondaryDataSourcesEditorBeanImpl, SecurityRoleUserEntitiesSelectorBeanImpl, ServerAdminSessionManager, ServletWebComponent, SharingConfirmationPageComponentImpl, SimplePageComponentImpl, ThresholdExpressionBeanImpl, ViewFilterElementPanelBeanImpl, VisualizationPropertiesEditorBeanImpl, VisualizationsEditorBeanImpl, WebAppSessionManagerImpl, WebBlobImpl, WebChangeJournalSearchImpl, WebDBMSImpl, WebDeliveryThresholdsMetricImpl, WebDerivedElementsEditorObject, WebDerivedElementsHelper, WebDossierPersonalViewShortcutImpl, WebEmailDeviceImpl, WebEmailTransmitterImpl, WebFileDeviceImpl, WebFTPDeviceImpl, WebIServerSubscriptionDeliveryModeMobilePropertiesImpl, WebIServerSubscriptionDeliveryModePersonalViewPropertiesImpl, WebIServerSubscriptionDynamicRecipientListImpl, WebMobileDeviceImpl, WebPrinterDeviceImpl, WebReportDefinitionImpl, WebReusableThresholdsImpl, WebSessionManagerImpl, WebSubscriptionDeliveryModeEmailPropertiesImpl, WebSyncRecommendationFolder, WebSyncSearchFolder, WebTransmitterImpl, XDADataExplorerBeanImpl

public interface Persistable
extends EnumWebPersistableState

This interface provides the mechanism to save the state of a component in a String representation, as well as to restore the component from its saved state.

The saved state should be HTML compatible, which means, it could appear in any form, such as HTML form data, query string, cookies, or session variable.

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	restoreState(SAXSupport parser, java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attrs)	Restores a component from an embedded XML during a SAX parsing.
boolean	restoreState(java.lang.String state)	Restores a component based on its saved state.
java.lang.String	saveState()	Returns a java.lang.String representation of a component.
java.lang.String	saveState(int howMuchState)	Returns a java.lang.String representation of a component.
void	saveState(java.lang.StringBuffer buf, int howMuchState)	Saves and stores a component's state into a StringBuffer.
void	saveState(java.lang.StringBuffer buf, int howMuchState, int stateFlag)	Saves and stores a component's state into a StringBuffer.

Method Detail

saveState

java.lang.String saveState(int howMuchState)

Returns a java.lang.String representation of a component. The returned state should be HTML friendly. This method call is equivalent to call saveState(new StringBuffer(), howMuchState).

Parameters:

howMuchState - how much state information to save (EnumWebPersistableState).

Returns:

the serialized state of a component.

saveState

java.lang.String saveState()

Returns a java.lang.String representation of a component. The returned state should be HTML friendly. This method call is equivalent to call saveState(EnumWebPersistableState.TYPICAL_STATE_INFO).

Returns:

the serialized state of a component.

restoreState

boolean restoreState(java.lang.String state)

Restores a component based on its saved state.

Parameters:

state - the state of a component

Returns:

true if restoration succeeds.

saveState

void saveState(java.lang.StringBuffer buf,
               int howMuchState)
        throws java.lang.UnsupportedOperationException

Saves and stores a component's state into a StringBuffer. The returned state should be HTML friendly.

There are generally two formats of the saved state: flat state and XML representation. The minimum state is saved in flat state format, while the typical and maximum states are saved in XML string representation.

Parameters:

buf - a StringBuffer to store the saved state.

howMuchState - how much state information to save (EnumWebPersistableState).

Throws:

java.lang.UnsupportedOperationException - thrown if the component does not support this method, or does not support certain howMuchState level.

saveState

void saveState(java.lang.StringBuffer buf,
               int howMuchState,
               int stateFlag)
        throws java.lang.UnsupportedOperationException

Saves and stores a component's state into a StringBuffer. The returned state should be HTML friendly.

There are generally two formats of the saved state: flat state and XML representation. The minimum state is saved in flat state format, while the typical and maximum states are saved in XML string representation.

Parameters:

buf - a StringBuffer to store the saved state.

howMuchState - how much state information to save (EnumWebPersistableState).

stateFlag - bit-wise flag to indicate additional information about the state (EnumWebStateFlags).

Throws:

java.lang.UnsupportedOperationException - thrown if the component does not support this method, or does not support certain howMuchState level.

Since:

MicroStrategy Web 9.0.0

restoreState

boolean restoreState(SAXSupport parser,
                     java.lang.String uri,
                     java.lang.String localName,
                     java.lang.String qName,
                     org.xml.sax.Attributes attrs)

Restores a component from an embedded XML during a SAX parsing.

Parameters:

parser - a SAX parser processing the XML representation of a state

uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed

localName - The local name (without prefix), or the empty string if Namespace processing is not being performed

qName - The qualified name (with prefix), or the empty string if qualified names are not available

attrs - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object

Returns:

true to indicate a successful restoration. Otherwise, false will be returned.