public interface

WebProjectInstance

com.microstrategy.web.objects.WebProjectInstance

Class Overview

This class represents a single project on a single Intelligence Server. It can be used to gather information on the project.

Summary

Public Methods
abstract String getAlias()
abstract WebClusterNode[] getHostingNodes()
Returns a list of servers, which are hosting this project, in cluster.
abstract int getID()
Returns the ID of the project.
abstract String getProjectDSSID()
Returns the DSSID of the project.
abstract String getProjectDescription()
Returns the description of the project.
abstract WebProject getProjectInfo()
Returns the information WebProject about the project.
abstract String getProjectName()
Returns the name of the project.
abstract int getStatus()
Returns the status of the project.
abstract SimpleList getSubscriptions(WebSubscriptionsFilter filter, int blockBegin, int blockCount)
Returns a SimpleList collection of WebSubscription objects from this project
abstract SimpleList getSubscriptions(int deliveryMode)
Returns a SimpleList of WebSubscription objects that have been created for this WebProjectInstance by all users for a specified delivery type.
abstract SimpleList getSubscriptions(int deliveryMode, int blockBegin, int blockCount)
Returns a SimpleList collection of WebSubscription objects to which this particular user is subscribed to, for a specified delivery mode, from a specified begin block, up to a specified block count.
abstract void setStatus(int status)
Sets the status of the project.

Public Methods

public abstract String getAlias ()

public abstract WebClusterNode[] getHostingNodes ()

Returns a list of servers, which are hosting this project, in cluster. Since project may not be loaded on all servers in the cluter, this method will return those servers in the cluster, which has this project loaded.

Returns
  • WebClusterNode[] The array of cluster node which has this project loaded on it.

public abstract int getID ()

Returns the ID of the project. This is generally numbered sequentially on a server.

Returns
  • The ID of the project.

public abstract String getProjectDSSID ()

Returns the DSSID of the project.

Returns
  • A string representing the DSS ID of the project.

public abstract String getProjectDescription ()

Returns the description of the project.

Returns
  • The description of the project.

public abstract WebProject getProjectInfo ()

Returns the information WebProject about the project. Note: This would not be a populated object.

public abstract String getProjectName ()

Returns the name of the project.

Returns
  • A string representing the name of the project.

public abstract int getStatus ()

Returns the status of the project. This value should correspond to one of the values from EnumDSSXMLProjectStatus.

Returns
  • The project status.

public abstract SimpleList getSubscriptions (WebSubscriptionsFilter filter, int blockBegin, int blockCount)

Returns a SimpleList collection of WebSubscription objects from this project

Parameters
filter WebSubscriptionsFilter used to filter the results. A blank filter can be retrieved from getNewSubscriptionsFilter()
blockBegin , the starting count of subscription, it is 0-based index which means set it N will return subscriptions from the (N+1)th subscription.
blockCount , block size for the incremental fetch of subscription. If set it 0, will return all subscriptions from the starting count
Returns
Throws
WebObjectsException
WebObjectsException

public abstract SimpleList getSubscriptions (int deliveryMode)

Returns a SimpleList of WebSubscription objects that have been created for this WebProjectInstance by all users for a specified delivery type. The session used to make this call should have the necessary credentials and privileges to browse/monitor all subscriptions in the project.

Parameters
deliveryMode , from EnumDSSXMLSubscriptionDeliveryType
Throws
WebObjectsException
WebObjectsException

public abstract SimpleList getSubscriptions (int deliveryMode, int blockBegin, int blockCount)

Returns a SimpleList collection of WebSubscription objects to which this particular user is subscribed to, for a specified delivery mode, from a specified begin block, up to a specified block count.

Parameters
deliveryMode , from EnumDSSXMLSubscriptionDeliveryType
blockBegin , the starting count of subscription, it is 0-based index which means set it N will return subscriptions from the (N+1)th subscription.
blockCount , block size for the incremental fetch of subscription. If set it 0, will return all subscriptions from the starting count
Throws
WebObjectsException
WebObjectsException

public abstract void setStatus (int status)

Sets the status of the project. The value comes from EnumDSSXMLProjectStatus.

Parameters
status the project status
Throws
WebObjectsException thrown if any error occurs.