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 typeEnumDSSXMLObjectTypes
.DssXmlTypeProject. Also note that since a project is a first-class object, this interface extendsWebObjectInfo
, which gives access to methods applicable to all first-class objects.- Since:
- MicroStrategy Web 7.5.2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addDBRole(WebDBRole role)
Add a DBRole object to this projectSimpleList
getDBRoles()
WebObjectInfo
getDefaultDrillMap()
Returns aWebObjectInfo
representation of the drill map object associated with this projectWebDBRole
getPrimaryDBRole()
Returns aWebDBRole
objects that is the primary DB role for thisWebProjectInstance
.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 userWebObjectInfo
getSchema()
Returns aWebObjectInfo
representation of the schema object associated with this projectvoid
removeDBRole(WebDBRole role)
Remove a DBRole object from this projectvoid
removeQuota(WebUser user)
Remove existed quota link item for current project and specified user.void
setAlias(java.lang.String alias)
Sets an alias.void
setDefaultDrillMap(WebObjectInfo drillMap)
Sets the drillMap for this projectvoid
setPrimaryDBRole(WebDBRole role)
Set a DBRole object as a primary DB role for this projectvoid
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.-
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, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, 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 aWebObjectInfo
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 aWebObjectInfo
representation of the schema object associated with this project- Returns:
WebObjectInfo
Schema associated with this project
-
getDBRoles
SimpleList getDBRoles() throws WebObjectsException
- Returns:
- a
SimpleList
ofWebDBRole
objects - Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
getPrimaryDBRole
WebDBRole getPrimaryDBRole()
Returns aWebDBRole
objects that is the primary DB role for thisWebProjectInstance
.- 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 quotaoption
-EnumDSSXMLGetCubeQuotaAndInfosOption
- Returns:
- Throws:
WebObjectsException
- Since:
- MicroStrategy 10.8 and IServer 10.8 or later
-
-