Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

public interface

WebUserEntity

implements Persistable WebObjectInfo

com.microstrategy.web.objects.admin.users.WebUserEntity

Known Indirect Subclasses

WebUser, WebUserGroup

Class Overview

The WebUserEntity interface represents a user or group object. This interface is derived from WebObjectInfo, because users are first class objects in metadata. The user object exposes additional properties in addition to the WebObjectInfo interface's properties which can be used to modify the properties of the user. These properties can be changed by making the changes on this interface, then calling WebObjectSource.save on the WebUserEntity object to save it to metadata.

In order to create a new user or group, the getNewObject method on the WebObjectSource interface should be called. This will create a new WebUser object if the correct object type is passed to that method. For that method, the subtype must be passed to the getNewObject method to specify whether a user or group is being created. Once the new object is created, the properties of the object should be set. The minimal attributes that must be sent before saving the object are the login name and full name attributes - if these are not set, then the save will not succeed. In addition, any other properties can be set at that time. Once the WebUserEntity object's properties are set up, the WebObjectSource.save method can be called, which will save the user or group in the appropriate folder, with an appropriate name. The save method with only the object as a parameter should be called - if the other overloaded methods are called, the correct folder must be specified manually.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

Public Methods
abstract WebProject[]	getAccessibleProjects() Returns an array of accessible projects for the current user entity.
abstract WebPrivileges	getAllPrivileges() Returns the full list of privileges for the user entity within all projects.
abstract String	getAnalysisQuota(WebProject project) Get quota value for current user and specified project, return null indicate no analysis quota has been set@return
abstract WebUserGroup[]	getAncestorGroups() Returns all parents, grandparents of this user/group.
abstract String	getFullName() Returns the full name of the user or group.
abstract WebLDAPLoginInfo	getLDAPLoginInfo() Returns an interface which can be used to read and write LDAP-related information about the user entity.
abstract WebEditablePrivileges	getLocalPrivileges() This method returns a read/write collection of privileges which are set directly on the user/group.
abstract WebUserList	getParents() Returns an editable list of `WebUserEntity` objects which are considered to be parents of this user/group.
abstract WebUserSecurityFilters	getSecurityFilters() Returns an editable list of security filter-project mappings for the current user account.
abstract WebUserSecurityRoles	getSecurityRoles() Returns an editable list of security role-porject mappings for the current user account.
abstract WebSimpleSecurityPluginLoginInfo	getSimpleSecurityPluginLoginInfo()
abstract boolean	hasInheritedSecurityRoles(WebProject project) Returns `true` if for the given project any of the parent groups of the current user has a security role associated.
abstract boolean	isGroup() Returns whether this WebUserEntity refers to a group.
abstract void	removeAnalysisQuota(WebProject project) Remove existed quota link item for current user and specified project.
abstract void	setAnalysisQuota(int aq, WebProject project) Set quota value for current user and specified project, it will create new analysis quota link item if current user, project has no quota be set.
abstract void	setFullName(String fullName) Sets the full name of the user or group.

[Expand]

Inherited Methods

From interface com.microstrategy.utils.KeyedObject

From interface com.microstrategy.utils.serialization.Persistable

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 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 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()
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	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 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() Populates the fields on this object by asking the Intelligence Server for the object definition.
abstract void	populate(String xml) Populates the fields on this object by loading the given object definition XML.
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	setPropertyFlags(int flags) Set the current property flags

From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract WebProject[] getAccessibleProjects ()

Returns an array of accessible projects for the current user entity. A project is accessible if the user has any roles, inherited or directly assigned, associated with the project.

Returns

An array of WebProject, which are accessible for current user.

Throws

WebObjectsException	Thrown if an error occurs when retrieving data from the Intelligence Server.

public abstract WebPrivileges getAllPrivileges ()

Returns the full list of privileges for the user entity within all projects. This list will include inherited privileges, and each privilege can be examined to determine its source.

Returns

A read-only WebPrivileges object, containing the full list of privileges for the user.

Throws

WebObjectsException	Thrown if an error occurs when retrieving data from the Intelligence Server.

public abstract String getAnalysisQuota (WebProject project)

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

Parameters

project	`WebProject` object used as the key to get the analysis quota

Throws

WebObjectsException

public abstract WebUserGroup[] getAncestorGroups ()

Returns all parents, grandparents of this user/group.

Returns

An array of WebUserGroup, which contains all parents/grandparents of this user/group.

Throws

WebObjectsException	Thrown if an error occurs when retrieving data from the Intelligence Server.

public abstract String getFullName ()

Returns the full name of the user or group.

Returns

The full name of the user or group.

public abstract WebLDAPLoginInfo getLDAPLoginInfo ()

Returns an interface which can be used to read and write LDAP-related information about the user entity.

Returns

A WebLDAPLoginInfo object which can be used to read and write LDAP-related information about the user entity.

public abstract WebEditablePrivileges getLocalPrivileges ()

This method returns a read/write collection of privileges which are set directly on the user/group.

Returns

A WebEditablePrivileges collection, representing a read/write list of privilege values.

public abstract WebUserList getParents ()

Returns an editable list of WebUserEntity objects which are considered to be parents of this user/group.

Returns

A WebUserList containing the parents of this user/group.

public abstract WebUserSecurityFilters getSecurityFilters ()

Returns an editable list of security filter-project mappings for the current user account.

Returns

A WebUserSecurityFilters collection containing the security filter-project mappings.

Throws

WebObjectsException	Thrown if an error occurs when retrieving data from the Intelligence Server.

public abstract WebUserSecurityRoles getSecurityRoles ()

Returns an editable list of security role-porject mappings for the current user account.

Returns

A WebUserSecurityRoles collection containing the security role-project mappings.

Throws

WebObjectsException	Thrown if an error occurs when retrieving data from the Intelligence Server.

public abstract WebSimpleSecurityPluginLoginInfo getSimpleSecurityPluginLoginInfo ()

public abstract boolean hasInheritedSecurityRoles (WebProject project)

Returns true if for the given project any of the parent groups of the current user has a security role associated.

Parameters

project	`WebProject` object representing the project for which the security role should be checked

Returns

boolean stating whether the user inherits security roles

Throws

	WebObjectsException
WebObjectsException

public abstract boolean isGroup ()

Returns whether this WebUserEntity refers to a group. Note that this can also be checked by looking at the subtype of the object. If this is true, then the WebUserEntity object can be cast into a WebUserGroup object, otherwise, it can be cast into a WebUser object.

Returns

True if the account refers to a group, false otherwise.

public abstract void removeAnalysisQuota (WebProject project)

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

Parameters

project	`WebProject` object used as the key to remove the analysis quota

Throws

WebObjectsException

public abstract void setAnalysisQuota (int aq, WebProject project)

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

Parameters

project	`WebProject` object used as the key to set the analysis quota

Throws

WebObjectsException

public abstract void setFullName (String fullName)

Sets the full name of the user or group.

Parameters

fullName	The new full name to use for the user or group.

Interfaces

WebUserEntity

Class Overview

Summary

Public Methods

public abstract WebProject[] getAccessibleProjects ()

Returns

Throws

public abstract WebPrivileges getAllPrivileges ()

Returns

Throws

public abstract String getAnalysisQuota (WebProject project)

Parameters

Throws

public abstract WebUserGroup[] getAncestorGroups ()

Returns

Throws

public abstract String getFullName ()

Returns

public abstract WebLDAPLoginInfo getLDAPLoginInfo ()

Returns

public abstract WebEditablePrivileges getLocalPrivileges ()

Returns

public abstract WebUserList getParents ()

Returns

public abstract WebUserSecurityFilters getSecurityFilters ()

Returns

Throws

public abstract WebUserSecurityRoles getSecurityRoles ()

Returns

Throws

public abstract WebSimpleSecurityPluginLoginInfo getSimpleSecurityPluginLoginInfo ()

public abstract boolean hasInheritedSecurityRoles (WebProject project)

Parameters

Returns

Throws

public abstract boolean isGroup ()

Returns

public abstract void removeAnalysisQuota (WebProject project)

Parameters

Throws

public abstract void setAnalysisQuota (int aq, WebProject project)

Parameters

Throws

public abstract void setFullName (String fullName)

Parameters