Package com.microstrategy.web.objects

Interface WebProjectInstance

public interface WebProjectInstance

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

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAlias()
java.lang.String	getCreationTime()	Returns the creation time of this object, if that information is available.
long	getCreationTimeStamp()
WebClusterNode[]	getHostingNodes()	Returns a list of servers, which are hosting this project, in cluster.
int	getID()	Returns the ID of the project.
java.lang.String	getModificationTime()	Returns the last modification time of the object, if that information is available.
long	getModificationTimeStamp()
WebObjectInfo	getOwner()	Returns a WebObjectInfo object which corresponds to the owner of this object.
java.lang.String	getProjectDescription()	Returns the description of the project.
java.lang.String	getProjectDSSID()	Returns the DSSID of the project.
WebProject	getProjectInfo()	Returns the information WebProject about the project.
java.lang.String	getProjectName()	Returns the name of the project.
int	getStatus()	Returns the status of the project.
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.
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.
SimpleList	getSubscriptions(WebSubscriptionsFilter filter, int blockBegin, int blockCount)	Returns a SimpleList collection of WebSubscription objects from this project
boolean	hasOwner()
void	setStatus(int status)	Sets the status of the project.

Method Detail

getProjectDescription

java.lang.String getProjectDescription()

Returns the description of the project.

Returns:

The description of the project.

getProjectInfo

WebProject getProjectInfo()
                   throws WebObjectsException

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

Throws:

WebObjectsException

getHostingNodes

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.

Since:

MicroStrategy Web 8.0.0

getSubscriptions

SimpleList getSubscriptions(int deliveryMode)
                     throws WebObjectsException

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

Since:

MicroStrategy Web 9.0.0

getSubscriptions

SimpleList getSubscriptions(int deliveryMode,
                            int blockBegin,
                            int blockCount)
                     throws WebObjectsException

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

Since:

MicroStrategy Web 9.0.0

getSubscriptions

SimpleList getSubscriptions(WebSubscriptionsFilter filter,
                            int blockBegin,
                            int blockCount)
                     throws WebObjectsException

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 WebSubscriptionsSource.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:

SimpleList collection of WebSubscription objects

Throws:

WebObjectsException

Since:

MicroStrategy Web 9.0.1

setStatus

void setStatus(int status)
        throws WebObjectsException

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

Parameters:

status - the project status

Throws:

WebObjectsException - thrown if any error occurs.

Since:

MicroStrategy Web 9.0.0

getProjectDSSID

java.lang.String getProjectDSSID()

Returns the DSSID of the project.

Returns:

A string representing the DSS ID of the project.

getProjectName

java.lang.String getProjectName()

Returns the name of the project.

Returns:

A string representing the name of the project.

getStatus

int getStatus()

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

Returns:

The project status.

getID

int getID()

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

Returns:

The ID of the project.

getAlias

java.lang.String getAlias()

getCreationTime

java.lang.String getCreationTime()

Returns the creation time of this object, if that information is available.

Returns:

A string representing the creation time of this object.

getModificationTime

java.lang.String getModificationTime()

Returns the last modification time of the object, if that information is available.

Returns:

A string representing the last modification time of the object.

getCreationTimeStamp

long getCreationTimeStamp()

Returns:

the creation timestamp of this object, if that information is available.

getModificationTimeStamp

long getModificationTimeStamp()

Returns:

the modification timestamp of this object, if that information is available.

hasOwner

boolean hasOwner()

Returns:

whether there is an owner object available.

getOwner

WebObjectInfo getOwner()
                throws WebObjectsException

Returns a WebObjectInfo object which corresponds to the owner of this object.

Returns:

A WebObjectInfo object, representing the owner of this object

Throws:

WebObjectsException - Thrown if the owner of this object is not available.