java.lang.Object
- com.microstrategy.web.objects.WebObjectsFactory

```
public final class WebObjectsFactory
extends java.lang.Object
```
WebObjectsFactory is the factory class for the Web Objects API. This is the entry point for any operation which uses the Web Objects. When creating a new factory instance, it should be initialized with setMessagesManager(MessagesManager) to ensure underlying messages may be correctly localized. Since 9.0.2, if users need to get the proper css for a specific browser, they should set the browser type through setBrowserType(int). If they want to use proper locale, they should set the message through setMessagesManager(MessagesManager);

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`checkUserPrivilege(int privilegeType)`	Checks if the user has the particular privelege type
`protected boolean`	`checkUserPrivilege(int privilegeType, WebIServerSession session)`
`WebAssociatedScheduleSource`	`getAssociatedScheduleSource()`
`int`	`getBrowserType()`
`WebClusterAdmin`	`getClusterAdmin()`	Returns the `WebClusterAdmin` object
`WebClusterSource`	`getClusterSource()`	Returns a `WebClusterSource` object, which can be used for retrieving `WebClusterMembership`.
`java.lang.String`	`getDescriptor(java.lang.String key, java.lang.String defaultValue)`
`WebDocumentSource`	`getDocumentSource()`	Returns a `WebDocumentSource` object, which can be used for document-related operations.
`WebElementSource`	`getElementSourceObject()`	Returns a `WebElementSource` object, which can be used for element browsing.
`WebEncryptionKeysSource`	`getEncryptionKeysSource()`	Returns a `WebEncryptionKeysSource` object, which can be used to re-encrypt the mstr env
`java.lang.String`	`getFlexSettingsXml()`
`WebInboxSource`	`getInboxSource()`	Returns a `WebInboxSource` object, which can be used for inbox-related operations.
`static WebObjectsFactory`	`getInstance()`	Returns an instance of the WebObjectsFactory object.
`WebIServerSession`	`getIServerSession()`	Returns a `WebIServerSession` object, which can be used to create and set the session ID on the factory and all objects created from it.
`WebIServerSessionList`	`getIServerSessionList()`
`LicenseSource`	`getLicenseSource()`	Returns a `LicenseSource` object, which can be used for retrieving licensing information.
`WebMDUpdateSource`	`getMDUpdateSource()`	Returns a `WebMDUpdateSource` object, which can be used to update all or portions of the metadata
`MonitorSource`	`getMonitorSource(int type)`	Returns a type specific `MonitorSource` object, which can be used for retrieving monitoring information.
`ObjectLockSource`	`getObjectLockSource()`
`WebObjectSource`	`getObjectSource()`	Returns a `WebObjectSource` object, which can be used for object-related operations.
`WebProjectSource`	`getProjectSource()`	Returns a `WebProjectSource` object, which can be used for retrieving project information.
`WebReportSource`	`getReportSource()`	Returns a `WebReportSource` object, which can be used for report-related operations.
`int`	`getResolvedAnalysisQuota()`
`RWSource`	`getRWSource()`	Returns a `RWSource` object, which can be used for RW-related operations.
`WebScheduleSource`	`getScheduleSource()`	Returns a `WebScheduleSource` object, which can be used for scheduling-related operations.
`WebSubscriptionsSource`	`getSubscriptionsSource()`	Returns the `WebSubscriptionsSource` object that can be used to access all other objects needed for supporting Narrowcast functionality
`java.lang.String`	`getUserPrivilegeXml()`
`void`	`setBrowserType(int brwType)`	Set the browser type (@link `EnumBrowserType`)
`void`	`setMessagesManager(MessagesManager msgs)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getInstance
```
public static WebObjectsFactory getInstance()
```
    Returns an instance of the WebObjectsFactory object. This is the only way to obtain the factory object.
    
    Returns:
    
    A WebObjectsFactory instance, which can be used to construct the other Web Objects.
  - getObjectSource
```
public WebObjectSource getObjectSource()
```
    Returns a WebObjectSource object, which can be used for object-related operations.
    
    Returns:
    
    A WebObjectSource object.
  - getScheduleSource
```
public WebScheduleSource getScheduleSource()
```
    Returns a WebScheduleSource object, which can be used for scheduling-related operations.
    
    Returns:
    
    A WebScheduleSource object.
  - getAssociatedScheduleSource
```
public WebAssociatedScheduleSource getAssociatedScheduleSource()
```
  - getReportSource
```
public WebReportSource getReportSource()
```
    Returns a WebReportSource object, which can be used for report-related operations.
    
    Returns:
    
    A WebReportSource object.
  - getElementSourceObject
```
public WebElementSource getElementSourceObject()
```
    Returns a WebElementSource object, which can be used for element browsing.
    
    Returns:
    
    A new WebElementSource object.
  - getIServerSession
```
public WebIServerSession getIServerSession()
```
    Returns a WebIServerSession object, which can be used to create and set the session ID on the factory and all objects created from it.
    
    Returns:
    
    The WebIServerSession object which represents the session information which all objects derived from the factory will use.
  - getDocumentSource
```
public WebDocumentSource getDocumentSource()
```
    Returns a WebDocumentSource object, which can be used for document-related operations.
    
    Returns:
    
    A WebDocumentSource object.
  - getInboxSource
```
public WebInboxSource getInboxSource()
```
    Returns a WebInboxSource object, which can be used for inbox-related operations.
    
    Returns:
    
    A WebInboxSource object.
  - getSubscriptionsSource
```
public WebSubscriptionsSource getSubscriptionsSource()
```
    Returns the WebSubscriptionsSource object that can be used to access all other objects needed for supporting Narrowcast functionality
    
    Returns:
    
    the WebSubscriptionsSource object
  - getProjectSource
```
public WebProjectSource getProjectSource()
```
    Returns a WebProjectSource object, which can be used for retrieving project information.
    
    Returns:
    
    A new WebProjectSource object.
  - getClusterSource
```
public WebClusterSource getClusterSource()
```
    Returns a WebClusterSource object, which can be used for retrieving WebClusterMembership.
    
    Returns:
    
    the WebClusterSource object
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getMDUpdateSource
```
public WebMDUpdateSource getMDUpdateSource()
```
    Returns a WebMDUpdateSource object, which can be used to update all or portions of the metadata
    
    Returns:
    
    the WebClusterSource object
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getEncryptionKeysSource
```
public WebEncryptionKeysSource getEncryptionKeysSource()
```
    Returns a WebEncryptionKeysSource object, which can be used to re-encrypt the mstr env
    
    Returns:
    
    the WebEncryptionKeysSource object
    
    Since:
    
    MicroStrategy Web 10.2
  - getClusterAdmin
```
public WebClusterAdmin getClusterAdmin()
```
    Returns the WebClusterAdmin object
    
    Returns:
    
    the WebClusterAdmin object
  - checkUserPrivilege
```
public boolean checkUserPrivilege(int privilegeType)
                           throws WebObjectsException
```
    Checks if the user has the particular privelege type
    
    Parameters:
    
    privilegeType - integer value specifying the type of privilege that is to be checked This is a value from the enumeration EnumDSSXMLPrivilegeTypes
    
    Returns:
    
    boolean value indicating if the specific privilege is available
    
    Throws:
    
    WebObjectsException
  - checkUserPrivilege
```
protected boolean checkUserPrivilege(int privilegeType,
                                     WebIServerSession session)
                              throws WebObjectsException
```
    Throws:
    
    WebObjectsException
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getUserPrivilegeXml
```
public java.lang.String getUserPrivilegeXml()
                                     throws WebObjectsException
```
    Throws:
    
    WebObjectsException
    
    Since:
    
    MicroStrategy Web 8.1.1
  - getFlexSettingsXml
```
public java.lang.String getFlexSettingsXml()
                                    throws WebObjectsException
```
    Throws:
    
    WebObjectsException
    
    Since:
    
    MicroStrategy Web 8.1.1
  - getLicenseSource
```
public LicenseSource getLicenseSource()
```
    Returns a LicenseSource object, which can be used for retrieving licensing information.
    
    Returns:
    
    A new LicenseSource object.
    
    Since:
    
    MicroStrategy Web 7.5.2
  - getRWSource
```
public RWSource getRWSource()
```
    Returns a RWSource object, which can be used for RW-related operations.
    
    Returns:
    
    A RWSource object.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getIServerSessionList
```
public WebIServerSessionList getIServerSessionList()
```
    Since:
    
    MicroStrategy Web 8.0.1
  - getMonitorSource
```
public MonitorSource getMonitorSource(int type)
```
    Returns a type specific MonitorSource object, which can be used for retrieving monitoring information.
    
    Parameters:
    
    type - the monitoring type, a value from EnumWebMonitorType
    
    Returns:
    
    A MonitorSource object.
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getObjectLockSource
```
public ObjectLockSource getObjectLockSource()
```
    Since:
    
    MicroStrategy Web 9.0.0
  - setMessagesManager
```
public void setMessagesManager(MessagesManager msgs)
```
  - setBrowserType
```
public void setBrowserType(int brwType)
```
    Set the browser type (@link EnumBrowserType)
    
    Parameters:
    
    brwType -
  - getBrowserType
```
public int getBrowserType()
```
  - getDescriptor
```
public java.lang.String getDescriptor(java.lang.String key,
                                      java.lang.String defaultValue)
```
  - getResolvedAnalysisQuota
```
public int getResolvedAnalysisQuota()
                             throws WebObjectsException
```
    Throws:
    
    WebObjectsException

Class WebObjectsFactory

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

getObjectSource

getScheduleSource

getAssociatedScheduleSource

getReportSource

getElementSourceObject

getIServerSession

getDocumentSource

getInboxSource

getSubscriptionsSource

getProjectSource

getClusterSource

getMDUpdateSource

getEncryptionKeysSource

getClusterAdmin

checkUserPrivilege

checkUserPrivilege

getUserPrivilegeXml

getFlexSettingsXml

getLicenseSource

getRWSource

getIServerSessionList

getMonitorSource

getObjectLockSource

setMessagesManager

setBrowserType

getBrowserType

getDescriptor

getResolvedAnalysisQuota