public interface

WebProject

implements WebObjectInfo
com.microstrategy.web.objects.WebProject

Class Overview

The WebProject interface represents a first-class project object in metadata. This object corresponds to an object of type EnumDSSXMLObjectTypes.DssXmlTypeProject. Also note that since a project is a first-class object, this interface extends WebObjectInfo, which gives access to methods applicable to all first-class objects.

Summary

Public Methods
abstract void addDBRole(WebDBRole role)
Add a DBRole object to this project
abstract SimpleList getDBRoles()
Returns a SimpleList of WebDBRole objects that have been created for this WebProjectInstance.
abstract WebObjectInfo getDefaultDrillMap()
Returns a WebObjectInfo representation of the drill map object associated with this project
abstract WebDBRole getPrimaryDBRole()
Returns a WebDBRole objects that is the primary DB role for this WebProjectInstance.
abstract WebObjectInfo getSchema()
Returns a WebObjectInfo representation of the schema object associated with this project
abstract void removeDBRole(WebDBRole role)
Remove a DBRole object from this project
abstract void setAlias(String alias)
Sets an alias.
abstract void setDefaultDrillMap(WebObjectInfo drillMap)
Sets the drillMap for this project
abstract void setPrimaryDBRole(WebDBRole role)
Set a DBRole object as a primary DB role for this project
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract void addDBRole (WebDBRole role)

Add a DBRole object to this project

Parameters
role WebDBRole to be added

public abstract SimpleList getDBRoles ()

Returns a SimpleList of WebDBRole objects that have been created for this WebProjectInstance.

Returns
Throws
WebObjectsException
WebObjectsException

public abstract WebObjectInfo getDefaultDrillMap ()

Returns a WebObjectInfo representation of the drill map object associated with this project

Returns

public abstract WebDBRole getPrimaryDBRole ()

Returns a WebDBRole objects that is the primary DB role for this WebProjectInstance.

Returns

public abstract WebObjectInfo getSchema ()

Returns a WebObjectInfo representation of the schema object associated with this project

Returns

public abstract void removeDBRole (WebDBRole role)

Remove a DBRole object from this project

Parameters
role WebDBRole to be removed

public abstract void setAlias (String alias)

Sets an alias. If a project has an alias, it will be used in lieu of its name.

public abstract void setDefaultDrillMap (WebObjectInfo drillMap)

Sets the drillMap for this project

Parameters
drillMap WebObjectInfo representation of a drillMap to be associated with this project

public abstract void setPrimaryDBRole (WebDBRole role)

Set a DBRole object as a primary DB role for this project

Parameters
role String containing the DBRole ID to be added