WebObjectsFactory
extends Object| java.lang.Object | |
| ↳ | com.microstrategy.web.objects.WebObjectsFactory |
Class Overview
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);
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean |
checkUserPrivilege(int privilegeType)
Checks if the user has the particular privelege type
| ||||||||||
| WebAssociatedScheduleSource | getAssociatedScheduleSource() | ||||||||||
| int | getBrowserType() | ||||||||||
| WebClusterAdmin |
getClusterAdmin()
Returns the
WebClusterAdmin object | ||||||||||
| WebClusterSource |
getClusterSource()
Returns a
WebClusterSource object, which can be used for retrieving
WebClusterMembership. | ||||||||||
| String | getDescriptor(String key, 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 | ||||||||||
| String | getFlexSettingsXml() | ||||||||||
| 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() | ||||||||||
| WebInboxSource |
getInboxSource()
Returns a
WebInboxSource object, which can be used for inbox-related operations. | ||||||||||
| static WebObjectsFactory |
getInstance()
Returns an instance of the WebObjectsFactory object.
| ||||||||||
| 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. | ||||||||||
| RWSource |
getRWSource()
Returns a
RWSource object, which can be used for RW-related operations. | ||||||||||
| WebReportSource |
getReportSource()
Returns a
WebReportSource object, which can be used for report-related operations. | ||||||||||
| int | getResolvedAnalysisQuota() | ||||||||||
| 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 | ||||||||||
| String | getUserPrivilegeXml() | ||||||||||
| void |
setBrowserType(int brwType)
Set the browser type (@link
EnumBrowserType) | ||||||||||
| void | setMessagesManager(MessagesManager msgs) | ||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean | checkUserPrivilege(int privilegeType, WebIServerSession session) | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Methods
public boolean checkUserPrivilege (int privilegeType)
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 |
|---|
public int getBrowserType ()
public WebClusterAdmin getClusterAdmin ()
Returns the WebClusterAdmin object
Returns
- the
WebClusterAdminobject
public WebClusterSource getClusterSource ()
Returns a WebClusterSource object, which can be used for retrieving
WebClusterMembership.
Returns
- the WebClusterSource object
public String getDescriptor (String key, String defaultValue)
public WebDocumentSource getDocumentSource ()
Returns a WebDocumentSource object, which can be used for document-related operations.
Returns
- A
WebDocumentSourceobject.
public WebElementSource getElementSourceObject ()
Returns a WebElementSource object, which can be used for element browsing.
Returns
- A new
WebElementSourceobject.
public WebEncryptionKeysSource getEncryptionKeysSource ()
Returns a WebEncryptionKeysSource object, which can be used to re-encrypt the mstr env
Returns
- the WebEncryptionKeysSource object
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
WebIServerSessionobject which represents the session information which all objects derived from the factory will use.
public WebInboxSource getInboxSource ()
Returns a WebInboxSource object, which can be used for inbox-related operations.
Returns
- A
WebInboxSourceobject.
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.
public LicenseSource getLicenseSource ()
Returns a LicenseSource object, which can be used for retrieving licensing
information.
Returns
- A new LicenseSource object.
public WebMDUpdateSource getMDUpdateSource ()
Returns a WebMDUpdateSource object, which can be used to update all or portions of the metadata
Returns
- the WebClusterSource object
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
MonitorSourceobject.
public WebObjectSource getObjectSource ()
Returns a WebObjectSource object, which can be used for object-related
operations.
Returns
- A
WebObjectSourceobject.
public WebProjectSource getProjectSource ()
Returns a WebProjectSource object, which can be used for retrieving project information.
Returns
- A new
WebProjectSourceobject.
public RWSource getRWSource ()
Returns a RWSource object, which can be used for RW-related operations.
Returns
- A RWSource object.
public WebReportSource getReportSource ()
Returns a WebReportSource object, which can be used for report-related operations.
Returns
- A
WebReportSourceobject.
public WebScheduleSource getScheduleSource ()
Returns a WebScheduleSource object, which can be used for scheduling-related
operations.
Returns
- A
WebScheduleSourceobject.
public WebSubscriptionsSource getSubscriptionsSource ()
Returns the WebSubscriptionsSource object that can be used to access
all other objects needed for supporting Narrowcast functionality
Returns
- the
WebSubscriptionsSourceobject
Protected Methods
protected boolean checkUserPrivilege (int privilegeType, WebIServerSession session)
Throws
| WebObjectsException |
|---|