public class

WebBeanFactory

extends AbstractLocalBeanFactory
implements EnumEventHandlerTypes EnumWebTransformableType
java.lang.Object
   ↳ com.microstrategy.web.beans.AbstractLocalBeanFactory
     ↳ com.microstrategy.web.beans.WebBeanFactory

Class Overview

This class is a factory for instantiating various WebBean or other Transformable compliant objects in the com.microstrategy.web.beans package. Note that most methods on this class are deprecated; we now provide the BeanFactory class for programmatic bean creation. Please create beans using the BeanFactory instead of using this class directly.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.beans.EnumEventHandlerTypes
From interface com.microstrategy.web.beans.EnumWebTransformableType
Protected Constructors
WebBeanFactory()
Constructs a WebBeanFactory with no parameter.
Public Methods
SecurityFilterBean createNewSecurityFilter()
This method is deprecated. Call newBean(String) to create a new SecurityFilterBean, then call InitAsNew() on the new bean instance.
static Class getBeanInterface(int beanType)
This method is deprecated. Reference bean interface classes directly rather than calling this method. If you need to use reflection to get/set properties on a bean, consider using the ReflectionHelper class.
synchronized static WebBeanFactory getInstance()
Returns a singleton of the WebBeanFactory.
AddressListBean newAddressListBean()
This method is deprecated. Use newBean(String) instead.
AttributeBean newAttributeBean()
BeanContext newBeanContext()
Instantiates a BeanContext.
DataExplorerBean newDataExplorerBean()
This method is deprecated. Use newBean(String) instead.
DocumentBean newDocumentBean()
This method is deprecated. Use newBean(String) instead.
ExpressionDisplayBean newExpressionDisplayBean()
This method is deprecated. Use newBean(String) instead.
ExpressionObject newExpressionObject(WebExpression pExpression, BeanContext pContext)
Instantiates a ExpressionObject.
ExpressionObject newExpressionObject(WebExpression pExpression, BeanContext pContext, WebWorkingSet pWorkingSet)
nstantiates a ExpressionObject.
FolderBean newFolderBean()
This method is deprecated. Use newBean(String) instead.
GraphBean newGraphBean()
This method is deprecated. Use newBean(String) instead.
InboxBean newInboxBean()
This method is deprecated. Use newBean(String) instead.
MarkupOutput newMarkupOutput(boolean encode)
Instantiates a MarkupOutput.
MarkupOutput newMarkupOutput()
Instantiates a MarkupOutput.
PromptDefinitionBean newPromptDefinitionBean()
This method is deprecated. Use newBean(String) instead.
PromptsBean newPromptsBean()
This method is deprecated. Use newBean(String) instead.
RWBean newRWBean()
This method is deprecated. Use newBean(String) instead.
ReportBean newReportBean()
This method is deprecated. Use newBean(String) instead.
ScheduleBean newScheduleBean()
This method is deprecated. Use newBean(String) instead.
SecurityFilterBean newSecurityFilterBean()
This method is deprecated. Use newBean(String) instead.
SecurityRoleBean newSecurityRoleBean()
This method is deprecated. Use newBean(String) instead.
SubscriptionBean newSubscriptionBean()
This method is deprecated. Use newBean(String) instead.
SubscriptionFolderBean newSubscriptionFolderBean()
This method is deprecated. Use newBean(String) instead.
ThresholdExpressionBean newThresholdExpressionBean()
This method is deprecated. Use newBean(String) instead.
UserBean newUserBean()
This method is deprecated. Use newBean(String) instead.
UserEntitiesBean newUserEntitiesBean()
This method is deprecated. Use newBean(String) instead.
UserGroupBean newUserGroupBean()
This method is deprecated. Use newBean(String) instead.
UserSearchBean newUserSearchBean()
This method is deprecated. Use newBean(String) instead.
WebBean newWebBean(int webBeanType)
This method is deprecated. Use newBean(String) instead.
Protected Methods
String getBeanPackage()
Returns the full name of the package associated with this factory (ex: "com.microstrategy.web.beans").
WebEventHandler getEventHandler(int type)
This method is deprecated. To get the default event-handler associated with a bean, create a new instance of that bean and call getWebEventHandler.
[Expand]
Inherited Methods
From class com.microstrategy.web.beans.AbstractLocalBeanFactory
From class java.lang.Object
From interface com.microstrategy.web.beans.LocalBeanFactory

Protected Constructors

protected WebBeanFactory ()

Constructs a WebBeanFactory with no parameter. It ensures that this factory gets never instantiated outside.

Public Methods

public SecurityFilterBean createNewSecurityFilter ()

This method is deprecated.
Call newBean(String) to create a new SecurityFilterBean, then call InitAsNew() on the new bean instance.

public static Class getBeanInterface (int beanType)

This method is deprecated.
Reference bean interface classes directly rather than calling this method. If you need to use reflection to get/set properties on a bean, consider using the ReflectionHelper class.

Returns the java.lang.Class object associated with each type specific WebBean.

Parameters
beanType the bean type of EnumWebTransformableType
Returns
  • the java.lang.Class associated with each type specific WebBean.

public static synchronized WebBeanFactory getInstance ()

Returns a singleton of the WebBeanFactory. This is the only entry point to gain access to various WebBean and other Transformable compliant objects.

Returns
  • the singleton of this WebBeanFactory.

public AddressListBean newAddressListBean ()

This method is deprecated.
Use newBean(String) instead.

Instantiates a AddressListBean.

Returns
  • A new AddressListBean instance.

public AttributeBean newAttributeBean ()

public BeanContext newBeanContext ()

Instantiates a BeanContext.

Returns
  • A new BeanContext instance.

public DataExplorerBean newDataExplorerBean ()

This method is deprecated.
Use newBean(String) instead.

Instantiates a DataExplorerBean.

Returns
  • A new DataExplorerBean instance.

public DocumentBean newDocumentBean ()

This method is deprecated.
Use newBean(String) instead.

Instantiates a DocumentBean.

Returns
  • A new DocumentBean instance.

public ExpressionDisplayBean newExpressionDisplayBean ()

This method is deprecated.
Use newBean(String) instead.

public ExpressionObject newExpressionObject (WebExpression pExpression, BeanContext pContext)

Instantiates a ExpressionObject.

Parameters
pExpression an instance of WebExpression from where this ExpressionObject originates.
pContext an instance of BeanContext.
Returns
  • A new ExpressionObject instance.

public ExpressionObject newExpressionObject (WebExpression pExpression, BeanContext pContext, WebWorkingSet pWorkingSet)

nstantiates a ExpressionObject.

Parameters
pExpression an instance of WebExpression from where this ExpressionObject originates.
pContext an instance of BeanContext.
pWorkingSet an instance of WebWorkingSet.
Returns
  • A new ExpressionObject instance.

public FolderBean newFolderBean ()

This method is deprecated.
Use newBean(String) instead.

Instantiates a FolderBean.

Returns
  • A new FolderBean instance.

public GraphBean newGraphBean ()

This method is deprecated.
Use newBean(String) instead.

Instantiates a FolderBean.

Returns
  • A new GraphBean instance.

public InboxBean newInboxBean ()

This method is deprecated.
Use newBean(String) instead.

Instantiates a InboxBean.

Returns
  • A new InboxBean instance.

public MarkupOutput newMarkupOutput (boolean encode)

Instantiates a MarkupOutput.

Parameters
encode a boolean indicating whether encoding is needed for the makrupOutput implementation.
Returns
  • A new MarkupOutput instance.

public MarkupOutput newMarkupOutput ()

Instantiates a MarkupOutput.

Returns
  • A new MarkupOutput instance.

public PromptDefinitionBean newPromptDefinitionBean ()

This method is deprecated.
Use newBean(String) instead.

public PromptsBean newPromptsBean ()

This method is deprecated.
Use newBean(String) instead.

Instantiates a PromptsBean.

Returns
  • A new PromptsBean instance.

public RWBean newRWBean ()

This method is deprecated.
Use newBean(String) instead.

Returns a new RWBean.

Returns
  • a new RWBean.

public ReportBean newReportBean ()

This method is deprecated.
Use newBean(String) instead.

Instantiates a ReportBean.

Returns
  • A new ReportBean instance.

public ScheduleBean newScheduleBean ()

This method is deprecated.
Use newBean(String) instead.

Instantiates a ScheduleBean.

Returns
  • A new ScheduleBean instance.

public SecurityFilterBean newSecurityFilterBean ()

This method is deprecated.
Use newBean(String) instead.

public SecurityRoleBean newSecurityRoleBean ()

This method is deprecated.
Use newBean(String) instead.

public SubscriptionBean newSubscriptionBean ()

This method is deprecated.
Use newBean(String) instead.

Instantiates a SubscriptionBean.

Returns
  • A new SubscriptionBean instance.

public SubscriptionFolderBean newSubscriptionFolderBean ()

This method is deprecated.
Use newBean(String) instead.

Instantiates a SubscriptionFolderBean.

Returns
  • A new SubscriptionFolderBean instance.

public ThresholdExpressionBean newThresholdExpressionBean ()

This method is deprecated.
Use newBean(String) instead.

public UserBean newUserBean ()

This method is deprecated.
Use newBean(String) instead.

Returns a new UserBean.

Returns
  • a new UserBean.

public UserEntitiesBean newUserEntitiesBean ()

This method is deprecated.
Use newBean(String) instead.

Returns a new UserEntitiesBean.

Returns
  • a new UserEntitiesBean.

public UserGroupBean newUserGroupBean ()

This method is deprecated.
Use newBean(String) instead.

Returns a new UserGroupBean.

Returns
  • a new UserGroupBean.

public UserSearchBean newUserSearchBean ()

This method is deprecated.
Use newBean(String) instead.

Returns a new UserSearchBean.

Returns
  • a new UserSearchBean.

public WebBean newWebBean (int webBeanType)

This method is deprecated.
Use newBean(String) instead.

Instantiates a type specific WebBean with the specified bean type.

Parameters
webBeanType the bean type from EnumWebTransformableType
Returns
  • A type specific WebBean instance.

Protected Methods

protected String getBeanPackage ()

Returns the full name of the package associated with this factory (ex: "com.microstrategy.web.beans").

Returns
  • The name of the package associated with this factory.

protected WebEventHandler getEventHandler (int type)

This method is deprecated.
To get the default event-handler associated with a bean, create a new instance of that bean and call getWebEventHandler.

Instantiates a WebEventHandler with the specified type.

Parameters
type an event handler type
Returns
  • an instance of event handler with the specified type