Package com.microstrategy.web.objects

Interface WebProject

All Superinterfaces:

KeyedObject, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPromptSite

public interface WebProject
extends WebObjectInfo

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.

Since:

MicroStrategy Web 7.5.2

Method Summary

Modifier and Type	Method	Description
void	addDBRole(WebDBRole role)	Add a DBRole object to this project
SimpleList	getDBRoles()	Returns a SimpleList of WebDBRole objects that have been created for this WebProjectInstance.
java.lang.String	getDefaultCalendarId()	Get default calendar id of project.
WebObjectInfo	getDefaultDossierTemplate()	Get default dossier template of project.
java.lang.String	getDefaultDossierTemplateId()	Get default dossier template id of project.
WebObjectInfo	getDefaultDrillMap()	Returns a WebObjectInfo representation of the drill map object associated with this project
WebObjectInfo	getDefaultTimezone()	Get default timezone of project.
java.lang.String	getDefaultTimezoneId()	Get default timezone id of project.
WebDBRole	getPrimaryDBRole()	Returns a WebDBRole objects that is the primary DB role for this WebProjectInstance.
java.lang.Integer	getQuota(WebUser user)	Get project user level quota for current project and specified user, return null indicate no quota has been set.
java.util.Map<WebUser,java.lang.Integer>	getQuotas()	Get all project user level quotas for current project, return empty map indicate no user level quota has been set.
java.lang.String	getQuotaUsageXML(WebUser user, int option)	Get quota usage for project and specified user
WebObjectInfo	getSchema()	Returns a WebObjectInfo representation of the schema object associated with this project
boolean	isCalendarEnabled()	Check if project level calendar is enabled.
boolean	isTimezoneEnabled()	Get sensitivity of timezone for project.
void	removeDBRole(WebDBRole role)	Remove a DBRole object from this project
void	removeQuota(WebUser user)	Remove existed quota link item for current project and specified user.
void	setAlias(java.lang.String alias)	Sets an alias.
void	setCalendarEnabled(boolean isCalendarEnabled)	Set if project calendar is enabled.
void	setDefaultCalendarId(java.lang.String defaultCalendarId)	Set default calendar id of project.
void	setDefaultDossierTemplateId(java.lang.String defaultDossierTemplateId)	Set default dossier template id of project.
void	setDefaultDrillMap(WebObjectInfo drillMap)	Sets the drillMap for this project
void	setDefaultTimezoneId(java.lang.String defaultTimezoneId)	Set default timezone id of project.
void	setPrimaryDBRole(WebDBRole role)	Set a DBRole object as a primary DB role for this project
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.
void	setTimezoneEnabled(boolean isTimezoneSensitive)	Set sensitivity of timezone for project.

Methods inherited from interface com.microstrategy.utils.KeyedObject

_getObKey

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit

addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

Methods inherited from interface com.microstrategy.web.objects.WebFeatures

isFeatureAvailable, isFeatureAvailable

Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo

buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDefaultLanguage, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getTemplateInfo, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDefaultLanguage, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

Methods inherited from interface com.microstrategy.web.objects.WebPromptSite

getPromptInstances

Method Detail

getDefaultDrillMap

WebObjectInfo getDefaultDrillMap()

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

Returns:

WebObjectInfo drillMap associated with this project

setDefaultDrillMap

void setDefaultDrillMap(WebObjectInfo drillMap)
                 throws WebObjectsException

Sets the drillMap for this project

Parameters:

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

Throws:

WebObjectsException

getSchema

WebObjectInfo getSchema()

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

Returns:

WebObjectInfo Schema associated with this project

getDBRoles

SimpleList getDBRoles()
               throws WebObjectsException

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

Returns:

a SimpleList of WebDBRole objects

Throws:

WebObjectsException

Since:

MicroStrategy Web 9.0.0

getPrimaryDBRole

WebDBRole getPrimaryDBRole()

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

Returns:

a WebDBRole objects

Since:

MicroStrategy Web 9.0.0

addDBRole

void addDBRole(WebDBRole role)
        throws WebObjectsException

Add a DBRole object to this project

Parameters:

role - WebDBRole to be added

Throws:

WebObjectsException

Since:

MicroStrategy Web 9.0.0

removeDBRole

void removeDBRole(WebDBRole role)
           throws WebObjectsException

Remove a DBRole object from this project

Parameters:

role - WebDBRole to be removed

Throws:

WebObjectsException

Since:

MicroStrategy Web 9.0.0

setPrimaryDBRole

void setPrimaryDBRole(WebDBRole role)
               throws WebObjectsException

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

Parameters:

role - String containing the DBRole ID to be added

Throws:

WebObjectsException

Since:

MicroStrategy Web 9.0.0

setAlias

void setAlias(java.lang.String alias)
       throws WebObjectsException

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

Throws:

WebObjectsException

getQuotas

java.util.Map<WebUser,java.lang.Integer> getQuotas()
                                                  throws WebObjectsException

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

Returns:

Throws:

WebObjectsException

getQuota

java.lang.Integer getQuota(WebUser user)
                    throws WebObjectsException

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

Parameters:

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

Returns:

Throws:

WebObjectsException

setQuota

void setQuota(WebUser user,
              int quota)
       throws WebObjectsException

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

removeQuota

void removeQuota(WebUser user)
          throws WebObjectsException

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

getQuotaUsageXML

java.lang.String getQuotaUsageXML(WebUser user,
                                  int option)
                           throws WebObjectsException

Get quota usage for project and specified user

Parameters:

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

option - EnumDSSXMLGetCubeQuotaAndInfosOption

Returns:

Throws:

WebObjectsException

Since:

MicroStrategy 10.8 and IServer 10.8 or later

isTimezoneEnabled

boolean isTimezoneEnabled()

Get sensitivity of timezone for project.

Returns:

true or false

Since:

MicroStrategy 11.3.4

setTimezoneEnabled

void setTimezoneEnabled(boolean isTimezoneSensitive)

Set sensitivity of timezone for project.

Parameters:

isTimezoneSensitive - boolean value to represent sensitivity

Since:

MicroStrategy 11.3.4

getDefaultTimezone

WebObjectInfo getDefaultTimezone()

Get default timezone of project.

Returns:

timezone objectWebObjectInfo

Since:

MicroStrategy 11.3.4

setDefaultTimezoneId

void setDefaultTimezoneId(java.lang.String defaultTimezoneId)
                   throws WebObjectsException

Set default timezone id of project.

Parameters:

defaultTimezoneId - timezone object id

Throws:

WebObjectsException

Since:

MicroStrategy 11.3.4

getDefaultTimezoneId

java.lang.String getDefaultTimezoneId()

Get default timezone id of project.

Returns:

default timezone id

Since:

MicroStrategy 11.3.4

setDefaultCalendarId

void setDefaultCalendarId(java.lang.String defaultCalendarId)

Set default calendar id of project.

Parameters:

defaultCalendarId - calendar object id

Since:

MicroStrategy 11.3.7

getDefaultCalendarId

java.lang.String getDefaultCalendarId()

Get default calendar id of project.

Returns:

calendar object id.

Since:

MicroStrategy 11.3.7

setCalendarEnabled

void setCalendarEnabled(boolean isCalendarEnabled)

Set if project calendar is enabled.

Parameters:

isCalendarEnabled - project calendar setting flag.

Since:

MicroStrategy 11.3.7

isCalendarEnabled

boolean isCalendarEnabled()

Check if project level calendar is enabled.

Returns:

project calendar setting flag.

Since:

MicroStrategy 11.3.7

getDefaultDossierTemplate

WebObjectInfo getDefaultDossierTemplate()

Get default dossier template of project.

Returns:

default dossier template.

Since:

MicroStrategy 11.3.7

setDefaultDossierTemplateId

void setDefaultDossierTemplateId(java.lang.String defaultDossierTemplateId)
                          throws WebObjectsException

Set default dossier template id of project.

Throws:

WebObjectsException

Since:

MicroStrategy 11.3.7

getDefaultDossierTemplateId

java.lang.String getDefaultDossierTemplateId()

Get default dossier template id of project.

Returns:

default dossier template object id.

Since:

MicroStrategy 11.3.7