public interface

WebUserEntity

implements Persistable WebObjectInfo
com.microstrategy.web.objects.admin.users.WebUserEntity
Known Indirect Subclasses

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
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 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

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

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
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
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

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

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.