Summary: Methods | Inherited Methods | [Expand All]

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 Integer	getQuota(WebUser user) Get project user level quota for current project and specified user, return null indicate no quota has been set.@return
abstract String	getQuotaUsageXML(WebUser user, int option) Get quota usage for project and specified user@return
abstract Map<WebUser, Integer>	getQuotas() Get all project user level quotas for current project, return empty map indicate no user level quota has been set.@return
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	removeQuota(WebUser user) Remove existed quota link item for current project and specified user.
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
abstract void	setQuota(WebUser user, int quota) Set quota value for current project and specified user, it will create new quota link item if current user has no quota set in project.

[Expand]

Inherited Methods

From interface com.microstrategy.utils.KeyedObject

From interface com.microstrategy.web.objects.WebDisplayUnit

abstract void	addDetails(boolean details) This method will add or remove details from the display unit.
abstract void	applyVisitor(DisplayUnitsVisitor visitor, boolean deep)
abstract boolean	canHighlight()
abstract WebDisplayUnits	getChildUnits() Returns the collection of child display units, or null if the object is not a collection.
abstract String	getDisplayName() Returns the display name associated with this object.
abstract int	getDisplayUnitType() Returns the type of display unit that this object represents.
abstract String	getID() Returns the DSS ID of the display unit.
abstract boolean	hasDetails() Returns whether this display unit currently has details enabled.
abstract void	highlightUnit() Sets this display unit to be highlighted.
abstract void	highlightUnit(boolean details) Sets this display unit to be highlighted.
abstract boolean	isHighlighted() Returns whether this unit is highlighted.
abstract boolean	isObjectInfo() Returns true if underlying Web Object can be cast to `WebObjectInfo`.
abstract boolean	isSelected() Returns whether this display unit is selected.
abstract void	setDisplayName(String displayName) This method will set the value of the display name.
abstract void	setSelected(boolean selected) Sets the current unit's selection status.

From interface com.microstrategy.web.objects.WebFeatures

From interface com.microstrategy.web.objects.WebObjectInfo

abstract void	buildShortObjectAttributes(WebXMLBuilder builder)
abstract void	buildShortXML(WebXMLBuilder builder)
abstract String	getAbbreviation() Returns the abbreviation of this object.
abstract int	getAccessGranted() Returns the current access granted on this object, if available.
abstract SimpleList	getAncestors() Returns a `SimpleList` containing the ancestors of this object, if they exist in the object XML.
abstract WebCertifiedInfo	getCertifiedInfo()
abstract String[]	getComments() Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object.
abstract String	getContainerDid()
abstract String	getContainerType()
abstract String	getCreationTime() Returns the creation time of this object, if that information is available.
abstract long	getCreationTimeStamp() Get the object creation timestamp in millisecond.
abstract String	getDataSources()
abstract String	getDescription() Returns the description of the object.
abstract int	getExtendedType() The current extended type
abstract WebObjectsFactory	getFactory() Returns WebObjectsFactory
abstract int	getFlags() Returns the flags which determine what data to populate upon calling populate.
abstract String	getID() Returns the DSS ID of the object, if one exists.
abstract String	getIconPath() Return the icon path for the object
abstract String	getModificationTime() Returns the last modification time of the object, if that information is available.
abstract long	getModificationTimeStamp() Get the object modification timestamp in millisecond.
abstract String	getName() Returns the name of this object.
abstract boolean	getNonSchedulable() Get flag of whether the object is not schedulable
abstract int	getOtherNameTransCount() Returns the count of name translations for locales other than the current effective locale.
abstract WebObjectInfo	getOwner() Returns a WebObjectInfo object which corresponds to the owner of this object.
abstract WebFolder	getParent() Returns the parent folder of the current object, if it exists.
abstract int	getPreSaveAsFlags() Returns the flags which determine the previous save as prompt flag.
abstract String	getProjectId()
abstract String	getProjectName()
abstract int	getPropertyFlags() Retrieve the current property flags
abstract SimpleList	getPropertySetFilter() Returns an editable `SimpleList` where you can specify the list of propertySets that the getPropertySets call should be limited to Note that this filter is not retained in the state.
abstract WebPropertyGroup	getPropertySets() Returns the property sets associated with this object.
abstract WebRecommendationInfo	getRecommendationInfo() This contains all the information related to a recommendation search
abstract WebObjectSecurity	getSecurity() Returns the `WebObjectSecurity` object associated with this WebObjectInfo object.
abstract int	getState() Returns the state of the object.
abstract int	getSubType() Returns the subtype of the object.
abstract int	getType() Returns the type of this object.
abstract String	getVersionID() Returns the Version ID of the object, if one exists.
abstract WebViewMediaSettings	getViewMediaSettings()
abstract int	getVisualizationViewMode()
abstract String	getXML(boolean encode) Returns the XML representation of this object.
abstract String	getXML() Returns the XML representation of this object.
abstract boolean	hasOwner()
abstract boolean	isAncestorNamedFolder(int folderName) Returns whether the named folder is this object's ancestor.
abstract boolean	isDirty() Returns whether this object has been modified to be different from the object in metadata.
abstract boolean	isEmbedded()
abstract boolean	isHidden() Returns whether the object is a hidden object.
abstract boolean	isNew() Returns whether this object is newly created at client side, which is not in the metadata.
abstract boolean	isPopulated() Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.
abstract void	populate(String xml) Populates the fields on this object by loading the given object definition XML.
abstract void	populate() Populates the fields on this object by asking the Intelligence Server for the object definition.
abstract void	setAbbreviation(String abbreviation)
abstract void	setComments(String[] comments) Set the long description of the object as an array of strings.
abstract void	setDataSources(String dataSourcesXML)
abstract void	setDescription(String description) Sets the description of the object.
abstract void	setExtendedType(int extendedType) Set the current extended type
abstract void	setFlags(int flags) Sets the flags which determine what data to populate upon calling populate.
abstract void	setHidden(boolean hidden) Sets whether the object is a hidden object.
abstract void	setIconPath(String iconPath) Set the icon path for the object
abstract void	setName(String _name)
abstract void	setNonSchedulable(boolean nonSchedulable) Set flag of whether the object is not schedulable
abstract void	setPreSaveAsFlags(int flags) Sets the flags which determine the previous save as prompt flag.
abstract void	setPropertyFlags(int flags) Set the current property flags

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

Throws

WebObjectsException

public abstract SimpleList getDBRoles ()

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

Returns

a SimpleList of WebDBRole objects

Throws

	WebObjectsException
WebObjectsException

public abstract WebObjectInfo getDefaultDrillMap ()

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

Returns

WebObjectInfo drillMap associated with this project

public abstract WebDBRole getPrimaryDBRole ()

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

Returns

a WebDBRole objects

public abstract Integer getQuota (WebUser user)

Get project user level quota for current project and specified user, return null indicate no quota has been set.@return

Parameters

user	`WebUser` object used as the key to get the project quota

Throws

WebObjectsException

public abstract String getQuotaUsageXML (WebUser user, int option)

Get quota usage for project and specified user@return

Parameters

user	`WebUser` object used as the key to get the project quota
option	`EnumDSSXMLGetCubeQuotaAndInfosOption`

Throws

WebObjectsException

public abstract Map<WebUser, Integer> getQuotas ()

Get all project user level quotas for current project, return empty map indicate no user level quota has been set.@return

Throws

WebObjectsException

public abstract WebObjectInfo getSchema ()

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

Returns

WebObjectInfo Schema associated with this project

public abstract void removeDBRole (WebDBRole role)

Remove a DBRole object from this project

Parameters

role	`WebDBRole` to be removed

Throws

WebObjectsException

public abstract void removeQuota (WebUser user)

Remove existed quota link item for current project and specified user.

Parameters

user	`WebUser` object used as the key to remove the quota

Throws

WebObjectsException

public abstract void setAlias (String alias)

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

Throws

WebObjectsException

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

Throws

WebObjectsException

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

Throws

WebObjectsException

public abstract void setQuota (WebUser user, int quota)

Set quota value for current project and specified user, it will create new quota link item if current user has no quota set in project.

Parameters

user	`WebUser` object used as the key to set the quota

Throws

WebObjectsException

Interfaces

Classes

Enums

Exceptions

WebProject

Class Overview

Summary

Public Methods

public abstract void addDBRole (WebDBRole role)

Parameters

Throws

public abstract SimpleList getDBRoles ()

Returns

Throws

public abstract WebObjectInfo getDefaultDrillMap ()

Returns

public abstract WebDBRole getPrimaryDBRole ()

Returns

public abstract Integer getQuota (WebUser user)

Parameters

Throws

public abstract String getQuotaUsageXML (WebUser user, int option)

Parameters

Throws

public abstract Map<WebUser, Integer> getQuotas ()

Throws

public abstract WebObjectInfo getSchema ()

Returns

public abstract void removeDBRole (WebDBRole role)

Parameters

Throws

public abstract void removeQuota (WebUser user)

Parameters

Throws

public abstract void setAlias (String alias)

Throws

public abstract void setDefaultDrillMap (WebObjectInfo drillMap)

Parameters

Throws

public abstract void setPrimaryDBRole (WebDBRole role)

Parameters

Throws

public abstract void setQuota (WebUser user, int quota)

Parameters

Throws