public interface

WebProjectSource

com.microstrategy.web.objects.WebProjectSource

Class Overview

The WebProjectSource object is used to execute project-related tasks. It can be obtained from WebObjectsFactory, and internally it will be associated with that factory. From the associated WebObjectsFactory, this source will retrieve neccessay information needed for performing its task, especially the WebIServerSession associated with the factory.

It acts as a source for retrieving list of projects and project flags. Note that the getProjects method will return those projects that are loaded on the server, while getAccessibleProjects will use the credentials set on the WebIServerSession object to return only those projects that the user can login to successfully. getRepositoryProjects will return all projects in the repository, regardless of whether they are loaded or not; this method is only useful for server administration.

Summary

Public Methods
abstract boolean checkPrivilege(String projectDSSID, int privilegeType)
Check the privilege based on the project.
abstract WebProjectInstances getAccessibleProjects()
Returns the WebProjectInstances object containing only those projects that the user can login to.
abstract WebProjectInstances getAccessibleProjectsInCluster()
Return #getAccessibleProjectsInCluster(boolean) with refresh set to true.
abstract WebProjectInstances getAllProjectsInCluster()
Returns the WebProjectInstances object containing all projects in cluster.
abstract WebProjectCreator getProjectCreator()
Returns a WebProjectCreator object which can be used to create a project on the IServer
abstract int getProjectFlags()
This is reserved for future use.
abstract WebPropertySet getProjectProperties(String propertySetName)
returns the project properties for a given property set name.
abstract WebProjectStatus getProjectStatus()
This method assumes that the session associated with this project source corresponds to a valid project The status of this project is returned
abstract WebProjectInstances getProjects()
Returns the WebProjectInstances object containing all projects that are loaded on the server.
abstract WebProjectInstances getProjects(boolean fromIServer)
Returns the WebProjectInstances object containing all projects that are loaded on the server.
abstract WebProjectInstances getProjectsInCluster()
Returns the WebProjectInstances object containing all projects that are loaded on any server in cluster.
abstract WebPromptCustomStyles getPromptCustomStyles()
Returns the prompt custom styles for this project
abstract WebProjectInstances getRepositoryProjects()
Returns the WebProjectInstances object containing all projects on the server, regardless of whether they are loaded or not.
abstract void saveProjectProperties(WebPropertySet wps)
Used to write back updated properties corresponding to property set wps that were retrieved using getProjectProperties(String)
abstract void setProjectFlags(int flags)
This is reserved for future use.
abstract void updateProjectsInCluster()
Cause the Intelligence Servers in cluster to load/unload projects according to the latest asymmetric clustering map.

Public Methods

public abstract boolean checkPrivilege (String projectDSSID, int privilegeType)

Check the privilege based on the project.

Parameters
projectDSSID - project DSS ID to check.
privilegeType - value from EnumDSSXMLPrivilegeTypes
Returns
  • true if the privilege is enabled
Throws
WebObjectsException if there is any error while retrieving privileges

public abstract WebProjectInstances getAccessibleProjects ()

Returns the WebProjectInstances object containing only those projects that the user can login to. Note that the credentials to use for this call come from the WebIServerSession object associated with the WebObjectsFactory object that this object came from. The credentials include: login name, password, authentication mode, server name and port number. These credentials need to be set up correctly on WebIServerSession before calling this method.

Returns
Throws
WebObjectsException Thrown if there is an error retrieving the list.

public abstract WebProjectInstances getAccessibleProjectsInCluster ()

Return #getAccessibleProjectsInCluster(boolean) with refresh set to true.

public abstract WebProjectInstances getAllProjectsInCluster ()

Returns the WebProjectInstances object containing all projects in cluster. Note that the credentials to use for this call come from the WebIServerSession object associated with the WebObjectsFactory object that this object came from. The credentails include: server name and port number. These credentails need to be set up correctly on WebIServerSession before calling this method.

Returns
  • WebProjectInstances object which is a collection of all projects in the cluster of the specific intelligence server (corresponding to the session).
Throws
WebObjectsException Thrown if there is an error retrieving the list.

public abstract WebProjectCreator getProjectCreator ()

Returns a WebProjectCreator object which can be used to create a project on the IServer

public abstract int getProjectFlags ()

This is reserved for future use. It has no effect right now. There is no enumeration associated with the project flags at this time.

Returns
  • integer indicating the project flags that are set. This is reserved for future use.

public abstract WebPropertySet getProjectProperties (String propertySetName)

returns the project properties for a given property set name. Note that these properties are returned from a cache and should be used for read-only purposes. In order to write back updated properties, please use saveProjectProperties(WebPropertySet)

Parameters
propertySetName the property set name
Returns
  • collection of properties as a WebPropertySet.
Throws
WebObjectsException if error was encountered on IServer while retrieving the properties.

public abstract WebProjectStatus getProjectStatus ()

This method assumes that the session associated with this project source corresponds to a valid project The status of this project is returned

Returns
  • the WebProjectStatus for the project specified and returns null if properties needed to read the status information do not exist
Throws
WebObjectsException if there is an error while reading the properties

public abstract WebProjectInstances getProjects ()

Returns the WebProjectInstances object containing all projects that are loaded on the server. Note that the credentials to use for this call come from the WebIServerSession object associated with the WebObjectsFactory object that this object came from. The credentails include: server name and port number. These credentails need to be set up correctly on WebIServerSession before calling this method.

Returns
  • WebProjectInstances object which is a collection of all loaded projects on the specific intelligence server (corresponding to the session).
Throws
WebObjectsException Thrown if there is an error retrieving the list.

public abstract WebProjectInstances getProjects (boolean fromIServer)

Returns the WebProjectInstances object containing all projects that are loaded on the server. Note that the credentials to use for this call come from the WebIServerSession object associated with the WebObjectsFactory object that this object came from. The credentails include: server name and port number. These credentails need to be set up correctly on WebIServerSession before calling this method.

Parameters
fromIServer boolean used to determine whether WebProjectInstances should come from IServer or Cache
Returns
  • WebProjectInstances object which is a collection of all loaded projects on the specific intelligence server (corresponding to the session).
Throws
WebObjectsException Thrown if there is an error retrieving the list.

public abstract WebProjectInstances getProjectsInCluster ()

Returns the WebProjectInstances object containing all projects that are loaded on any server in cluster. Note that the credentials to use for this call come from the WebIServerSession object associated with the WebObjectsFactory object that this object came from. The credentails include: server name and port number. These credentails need to be set up correctly on WebIServerSession before calling this method.

Returns
  • WebProjectInstances object which is a collection of all loaded projects in the cluster of the specific intelligence server (corresponding to the session).
Throws
WebObjectsException Thrown if there is an error retrieving the list.

public abstract WebPromptCustomStyles getPromptCustomStyles ()

Returns the prompt custom styles for this project

Returns
  • The WebPromptCustomStyles for this project. Can be used for retrieving, editing the current custom styles defined for this project
Throws
WebObjectsException Thrown when error happens during the retrieving.
IllegalArgumentException Thrown when error happens during the retrieving.

public abstract WebProjectInstances getRepositoryProjects ()

Returns the WebProjectInstances object containing all projects on the server, regardless of whether they are loaded or not. Note this call uses session ID come from the WebIServerSession object associated with the WebObjectsFactory object that this object came from. A valid session ID must be created in WebIServerSession before calling this method.

Returns
  • WebProjectInstances object which is a collection of all projects on the specific intelligence server (corresponding to the session).
Throws
WebObjectsException Thrown if there is an error retrieving the list.

public abstract void saveProjectProperties (WebPropertySet wps)

Used to write back updated properties corresponding to property set wps that were retrieved using getProjectProperties(String)

Throws
WebObjectsException
WebObjectsException

public abstract void setProjectFlags (int flags)

This is reserved for future use. It has no effect right now. There is no enumeration associated with the project flags at this time.

Parameters
flags integer argument specifying the project flags. This is reserved for future use.

public abstract void updateProjectsInCluster ()

Cause the Intelligence Servers in cluster to load/unload projects according to the latest asymmetric clustering map.