Package com.microstrategy.web.beans

Interface Summary

Interface	Description
AddressListBean	The AddressListBean is responsible for displaying and managing the user's address list.
AnnotationBean	The AnnotationBean is used to editing, updating or adding an annotation to a report or document.
AppSchemaBean
AssociatedSchedulesBean
AttributeBean	This bean is used for browsing attribute elements.
BeanContext	The BeanContext interface provides context information for a WebComponent or a Transformable, such as StyleCatalog and MessagesManager etc.
BeanProxy	This interface lists the IDs for the events and the IDs for the corresponding arguments for the events supported by the ExpressionBean.
ConstantPromptBean	Interface for the Constant Prompt Bean.
CustomGroupBean
DataExplorerBean	The DataExplorerBean is intended to support data explorer browsing.
DerivedElementBean	This bean represents a single Derived Element
DerivedElementBean.Host	Represents this bean's host
DimtyPromptBean	Interface of the Dimty Prompt Bean.
DocumentBean	This interface is used to manage the collection of document data and enable it to be rendered.
EditableBean	This interface reprents a kind of beans which can be edited.
EditableObjectBean	This interface represents an editable object bean.
ElementPromptBean	Interface for the Element Prompt Bean.
EncodedMarkupOutput	This object is used to perform everything MakrupOuptput is supposed to do but with js encoding performed upon appending a string.
EnumAddressListBeanEvents	This interface defines all the event IDs and event arguments for the AddressListBean.
EnumAnnotationBeanEvents
EnumAssociatedSchedulesBeanEvents
EnumAttributeBeanEvents
EnumBeanErrorCodes	This interface defines error codes for SubscriptionBean and ScheduleBean.
EnumBeanOutputFormat	Possible values for bean output format
EnumBeanPersistMode	Possible values for bean persistence mode
EnumCustomGroupBeanEvents
EnumDataExplorerBeanEvents	Interface declaring events and event arguments for the DataExplorerBean.
EnumDerivedElementBeanEvents	This interface lists the IDs for the events and the IDs for the corresponding arguments for the events supported by the ExpressionBean.
EnumDimensionalityLevel	This enumeration corresponds to the GUI options for the dimensionality level of expressions.
EnumDocumentBeanEvents	Constants for document bean events
EnumEditableObjectBeanEvents	Constants for editable objects bean events
EnumEventElement	This is a Java interface that defines a set of numeric constants for use with the ParameterBuilder.addEventInfo(com.microstrategy.web.beans.WebEvent, int, int) method.
EnumEventHandlerTypes	The EnumEventHandlerTypes interface lists the types of event handlers supported in the SDK layer.
EnumExpressionBeanEvents	This interface lists the IDs for the events and the IDs for the corresponding arguments for the events supported by the ExpressionBean.
EnumExpressionBeanType	This enumeration describes the different types of expression bean.
EnumExpressionEditMode	This enumeration describes the different edit modes which can be applied to a filter object.
EnumExpressionPromptBeanTypes	The enumeration values for the expression types in an expression prompt bean.
EnumFilterBeanEvents	This interface lists the IDs for the events and the IDs for the corresponding arguments for the events supported by the FolderBean
EnumFolderBeanEvents	This interface lists the IDs for the events and the IDs for the corresponding arguments for the events supported by the FolderBean
EnumGenericEvents	Events and arguments for the event handler base class.
EnumGradientShadingStyles	Constants for gradient shading style
EnumGradientTransitionTypes	Constants for gradient transition type (These values are in sync with what 3D Graphics expects)
EnumGroupBeanEvents	This interface defines all events ID and arguments for UserGroupBean.
EnumImportWizardBeanEvents
EnumInboxBeanEvents	Constants for inbox bean events
EnumObjectBeanEvents	This interface lists the IDs for the events and the IDs for the corresponding arguments for the events supported by the ObjectBean
EnumObjectPromptBeanEvents
EnumPageInfoDirection	Possible values for logical pages browsing direction
EnumParameterType	Deprecated. As of 8.0, use the constants in EnumEventElement.
EnumPromptAnswerBeanEvents
EnumPromptAnswerFormat	Possible values for promt answer formatting
EnumPromptAnswerOptions	This interface specifies flags indicating what to do when answering a prompt, especially when the answer the caller provides is empty or null.
EnumPromptBeanEvents
EnumPromptDefinitionBeanEvents	Events for the prompt definition bean.
EnumPromptExpressionBeanEvents
EnumPromptsBeanEvents	This interface defines all the IDs for prompt handling events and their arguments supported by the MicroStrategy SDK prompts event handler.
EnumPromptsBeanTypes	This interface defines the enumeration constants used to specify the prompt type.
EnumPromptsSourceTypes	This interface defines the enumeration constants used to specify the PromptSource type.
EnumReportBeanEvents	This interface lists the IDs for the events and the IDs for the corresponding arguments for the events supported by the ReportBean
EnumReportPageType	This interface defines two constants differentiating two types of ReportPageInfo: absolute page info and relative page info.
EnumRequestStatus	Constants describing the request status of a bean.
EnumRWBeanEvents
EnumRWViewModes	Possible values for document view mode
EnumScheduleBeanEvents	Deprecated. Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions.
EnumSearchWildcards	This enumeration defines commonly encountered scenarios of appending wildcards for pattern matching.
EnumSecurityFilterBeanEvents	Title:
EnumSecurityPluginProvidersBase
EnumSecurityRoleEvents
EnumSubscriptionBeanEvents	This interface defines all the event IDs and event arguments for the SubscriptionBean.
EnumSubscriptionFolderBeanEvents	This interface defines all the event IDs and event arguments for the SubscriptionFolderBean.
EnumThresholdTypes
EnumUserBeanEvents	This interface defines all events ID and arguments for UserBean.
EnumUserEntitiesBeanEvents	This interface defines all events ID and arguments for UserEntitiesBean.
EnumUserEntitiesSourceTypes
EnumUserEntityBeanEvents	This interface defines all events ID and arguments for UserEntityBean
EnumUserSearchBeanEvents	Constants for UserSearchBean bean events
EnumViewBeanEvents	Constants for ViewBean events
EnumWebFeatures	This is the enumeration of all the features that are available for the web application at the SDK level. A WebFeature is a generic term for a variety of preferences, privileges, settings, etc.
EnumWebPromptAnswerMode	This interface represents the available values for the PromptAnswerMode parameter in the prompt answer events.
EnumWebTransformableType	This interface defines constants for the various types of Transformable objects that are available
ExpressionBean	The ExpressionBean interface represents a bean which can be used to edit an expression.
ExpressionBeanContext	The ExpressionBeanContext interface can be implemented by any object that can provide a context for an expression bean.
ExpressionDisplayBean	The ExpressionDisplayBean is a subclass of ExpressionBean that can only be used to display an expression - all undo and edit-related operations have been disabled.
ExpressionObject	This interface facilitates the transform of a WebExpression object through a few extra properties.
ExpressionPromptBean
ExternalPromptsSource	This interface represents a prompt source that exists outside of the Intelligence Server.
FilterBean
FolderBean	This interface along with its super interface ObjectBean supports the concept of object browsing.
GraphBean	The GraphBean encapsulates the WebGraph object, which contains the binary graph data.
HighlightedObject	This interface represents an object that a user selects on a Web browser and wants to highlight in the next Web page.
HighlightedObjects	This interface is a typical collection interface of HighlightedObject.
ImportWizardBean
InboxBean	The InboxBean interface allows the users to manage their History List.
LimitExpressionBean
LocalBeanFactory	The LocalBeanFactory interface specifies the contract that a package-level bean factory must implement--most importantly, the ability to create a bean based on its type name.
MarkupOutput	This object is used by a transform to record the results of a transformation.
MessageInfo	This interface provides information about a localized message.
Messages	The interface encapsulates messages information.
MetadataPromptsSource	This interface is used to represent a source of prompts that originates in the Intelligence Server metadata.
ObjectBean	This interface represents a generic metadata object.
ObjectPromptBean	Interface of the Object Prompt Bean
PerformanceMonitorBean	The MonitorBean is a bean which is used to monitor performance counters on a cluster of Intelligence Servers.
PromptAnswerBean	The PromptAnswerBean is represents a single WebPromptAnswer object.
PromptBean
PromptDefinitionBean	The PromptDefinitionBean is a bean which represents a prompt definition object in metadata.
PromptObject	This interface represents information about a single prompt.
PromptsBean	This interface acts as a controller to orchestrate the collection and assembly of prompt questions.
PromptsSource	This interface is the base interface from which two sub-interfaces are derived, the MetadaPromptsSource and ExternalPromptsSource interfaces.
ReportBean	This interface is used to manage the collection of report data and enable it to be rendered.
ReportPageInfo	This interface is designed specifically to support incremental fetch of report data.
RequestKeys	This interface stores a collection of keys from the request context.
RequestPersistable	This interface provides extra functionalities that allow restoration of state from a RequestKeys object.
ResultSetBean
RWBean	This interface is used to manage the collection of report writing document data and enable it to be rendered.
RWBeanVisitor	Provides a callback mechanism (invoked via RWBean.iterate(RWBeanVisitor, boolean, MarkupOutput)) to ease the handling of complex RWObject, by automatically mapping them to their respective WebBean helpers.
RWBeanVisitor2	| Enhanced version of bean visitor
RWViewBean
RWViewExpressionBean
ScheduleBean	Deprecated. Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions.
SecurityFilterBean
SecurityRoleBean
SubscriptionBean	This bean represents a Narrowcast subscription.
SubscriptionFolderBean
SubsetUnitLimitBean
ThresholdExpressionBean	The ThresholdExpressionBean represents an ExpressionBean that is editing a threshold's conditional expression.
ThresholdExpressionBeanContext	The ExpressionBeanContext interface can be implemented by any object that can provide a context for an expression bean.
Transformable	This interface represents objects that support Transform functionality.
TransformInstance	This interface manages a Transform object and its associated MarkupOutput object.
TransformKeyMapper
UserBean	This bean represents a single user.
UserEntitiesBean	This interface represents a collection of users.
UserEntityBean	This is the base interface for both UserBean and UserGroupBean.
UserGroupBean	This interface represents a group user.
UserSearchBean	This interface represents a search for user.
ViewBean	This interface provides a unified concept of the WebTemplate encapsulated by corresponding WebViewInstance along with its associated events for both the report, and report writing document.
WebBean	This interface represents a generic WebBean.
WebBeanError	This interface exposes the necessary methods to retrieve backend error code and error message when any of the Web Beans is interacting with the backend server.
WebComponent	The WebComponent interface abstracts every component of a Web application.
WebEvent	This interface abstracts user interaction with a WebComponent in a Web application.
WebEvent.Argument	The Argument interface represents a WebEvent argument.
WebEventHandler	This interface generates and handles a set of WebEvent.
WebEvents	The WebEvents interface represents an ordered collection of WebEvent.
WebEventTags	This interface defines XML tags and attributes used in defining a WebEventHandler or a WebEvent.
WebSessionManager	This is the interface for the MicroStrategy Web session manager.

Class Summary

Class	Description
AbstractEventHandlerFactory	Deprecated. Event-handlers factories are not used.
AbstractLimitExpressionBean
AbstractLocalBeanFactory	Default implementation of the LocalBeanFactory interface that resolves bean type names to bean classes by appending "Impl" to the bean type name.
AbstractRWBeanVisitor
AbstractRWBeanVisitor2
AbstractTransformable	This is a base class for transformable objects.
AbstractWebComponent	This class provides a skeletal implementation of the WebComponent interface to minimize the effort required to implement this interface.
AbstractWebFeatures	This acts as the base for all classes implementing feature support resolution.
AggregatedEventHandler	The AggregatedEventHandler class is intended for customization of existing event handlers.
AggregatedWebFeatures	MicroStrategy Web provides out of the box just a finite number of features based on its own requirements.
AssociatedSchedulesBeanImpl
AttributeEventHandler
BeanContextImpl	The class provides the default implementation of the interface BeanContext.
BeanFactory	The BeanFactory class allows the user to create both MicroStrategy beans and custom beans.
BeanFactory.BeanFactoryInfo
BeanFactory.BeanMappingInfo
BeanFactory.BeanMappingInfoList
BeanFactory.BeanPackageInfo
BeanFactory.BeanPackageInfoList
ComponentBlock	This class represents a component block generated for partial update request.
DataServerHelper
DerivedElementBeanImpl
DerivedElementEventHandler
EventArgumentInfo	This class represents the "argument" node from the XML.
EventArgumentInfoList	This class represents the "arguments" node from the XML.
EventHandlerInfo	This class represents the "eventHandler" node from the XML.
EventHandlersCatalog	This class is used to configure Microstrategy Web's event-handlers.
EventInfo	This class represents the "event" node from the XML.
EventInfoList	This class represents the "events" node from the XML.
ExpressionPromptEventHandlerImpl
FeatureArray	The purpose of this class is to act as a container for an arbitrary list of feature "segments".
FilterEventHandler	Title:
FormatBeanHelper
GenericEventHandler	This class provides the default implementation of the interface WebEventHandler.
GenericEventHandler.GenericEventKeys	This inner class is an implementation of the request keys specific for an event.
GenericMultipleEvents	The GenericMultipleEvents class represents an event that encompasses multiple events.
GenericRequestKeys	This class provides provides a skeletal implementation of the interface RequestKeys, to minimize the effort required to implement this interface and allow subclasses to focus only on how to initialize the key-values collection from various sources.
GenericWebEvent	This class provides a skeletal implemenation of the interface WebEvent, to minimize any effort to implement this interface.
GridWebFormatHelper	This class provides a series of methods that aid on the manipulation of grid formatting properties.
MessageInfoImpl
MessagesManager	This class contains a list of Messages instances, each of which is associated with a specific java.util.Locale object or a Windows LCID (Window-based locale ID).
PerformanceMonitorBeanManager	The PerformanceMonitorBeanManager has two purposes: (1) to act as a factory for PerformanceMonitorBean objects, and (2) to provide a persistence mechanism for them.
RWConditionSelectorHelper
SecurityFilterEventHandler	Title:
SecurityRoleEventHandler
SysEventHandler	The SysEventHandler is the base class for all those event-handlers that can be configured through an external events.xml.
ThresholdExpressionBeanImpl
ViewDisplayModeHelper
WebBeanFactory	This class is a factory for instantiating various WebBean or other Transformable compliant objects in the com.microstrategy.web.beans package.
WebBeanUtils	This class provides some utility functions for the bean package.
WebBeanUtils.SimpleRequestKeys
WebComponentFactory
WebEventHandlerFactory	Deprecated. This factory is not used.
WebEventUtils	The WebEventUtils class is a utility class, helping users to retrieve values from a WebEvent object.
WebSessionManagerImpl

Exception Summary

Exception	Description
BeanNotFoundException	Exception thrown by LocalBeanFactory and BeanFactory methods when a bean type name cannot be resolved to a class.
WebBeanException	Thrown when a WebBean encounters any error during the processing of its contents.
WebBeanScalableException
WebException	Thrown if the error is due to incorrect or unexpected user inputs from a Web browser.