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

public interface

WebUser

implements WebUserEntity

com.microstrategy.web.objects.admin.users.WebUser

Class Overview

The WebUser interface represents user-specific account information. The WebUser interface is obtained by casting the WebUserEntity interface. This interface contains only those properties which apply to users. Any properties which apply to both users and groups are inherited from the WebUserEntity interface.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

Public Methods
abstract void	createProfile() Create the profile folder for the particular user for the specified project Note that the profile folder will be created only when the user is saved.
abstract void	deleteProfile() Delete the profile folder for the particular user for the specified project Note that the profile folder will be deleted only when the user is saved.
abstract WebSubscriptionUserAddresses	getAddresses() Returns a `SimpleList` collection of `WebSubscriptionAddress` objects for the current user for all the delivery modes.
abstract WebSubscriptionContacts	getContacts() Returns a `WebSubscriptionContacts` interface, which is a collection of contacts that is associated to the current user entity.
abstract String	getDefaultEmailAddress() Get the default email address of the user.
abstract String	getLoginName() Returns the login name of the user.
abstract WebNTLoginInfo	getNTLoginInfo() Returns an interface which can be used to read and write NT-authentication-related information about the user.
abstract WebFolder	getProfile() Find the profile folder for the particular user.
abstract WebRDBMSLoginInfo	getRDBMSLoginInfo() Returns an interface which can be used to read and write RDBMS-related information about the user.
abstract WebStandardLoginInfo	getStandardLoginInfo() Returns an interface which can be used to read and write properties for the user relating to standard authentication.
abstract SimpleList	getSubscriptions(int deliveryMode) Returns a `SimpleList` collection of `WebSubscription` objects to which this particular user is subscribed to, for a specified delivery mode.
abstract SimpleList	getSubscriptions(WebSubscriptionsFilter filter, int blockBegin, int blockCount) Returns a `SimpleList` collection of `WebSubscription` objects to which this particular user is subscribed to, from a specified begin block, up to a specified block count.
abstract SimpleList	getSubscriptions(int deliveryMode, int blockBegin, int blockCount) Returns a `SimpleList` collection of `WebSubscription` objects to which this particular user is subscribed to, for a specified delivery mode, from a specified begin block, up to a specified block count.
abstract boolean	isEnabled() Returns whether the user is enabled or not.
abstract void	setEnabled(boolean isEnabled) Sets the user to be enabled/disabled.
abstract void	setLoginName(String loginName) Sets the login name of the user.
abstract void	setNewObjectID(String newObjectID) set the id used to create a new user, the id would be used as the id of the user after saving in MD.

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

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

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.

Public Methods

public abstract void createProfile ()

Create the profile folder for the particular user for the specified project Note that the profile folder will be created only when the user is saved. This operation requires a valid project session. The profile folder is created for the project to which the session is created.

Throws

	WebObjectsException
WebObjectsException

public abstract void deleteProfile ()

Delete the profile folder for the particular user for the specified project Note that the profile folder will be deleted only when the user is saved. This operation requires a valid project session. The profile folder is deleted for the project to which the session is created.

Throws

	WebObjectsException
WebObjectsException

public abstract WebSubscriptionUserAddresses getAddresses ()

Returns a SimpleList collection of WebSubscriptionAddress objects for the current user for all the delivery modes. This collection is read-only.

Throws

WebObjectsException

public abstract WebSubscriptionContacts getContacts ()

Returns a WebSubscriptionContacts interface, which is a collection of contacts that is associated to the current user entity.

Returns

A WebSubscriptionContacts object

Throws

WebObjectsException

public abstract String getDefaultEmailAddress ()

Get the default email address of the user. If the user is not generated from a quick search result, there will be a call made on the IServer to get the email address

Throws

	if you are getting the result from quick search, you can ignore this exception as it can not happen
WebObjectsException

public abstract String getLoginName ()

Returns the login name of the user.

Returns

The current login name of the user.

public abstract WebNTLoginInfo getNTLoginInfo ()

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

Returns

A WebNTLoginInfo object which can be used to read and write NT-related authentication information about the user.

public abstract WebFolder getProfile ()

Find the profile folder for the particular user. This operation requires a valid project session. The profile folder is returned for the project to which the session is created. An error is thrown if there is no profile folder in the project for this user.

Returns

A WebFolder that points to the profile folder for the user

Throws

	WebObjectsException
WebObjectsException

public abstract WebRDBMSLoginInfo getRDBMSLoginInfo ()

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

Returns

A WebRDBMSLoginInfo object which can be used to read and write RDBMS-related information about the user.

public abstract WebStandardLoginInfo getStandardLoginInfo ()

Returns an interface which can be used to read and write properties for the user relating to standard authentication.

Returns

A WebStandardLoginInfo object which can be used to read and write standard authentication-related information about the user.

public abstract SimpleList getSubscriptions (int deliveryMode)

Returns a SimpleList collection of WebSubscription objects to which this particular user is subscribed to, for a specified delivery mode.

Parameters

deliveryMode	, from `EnumDSSXMLSubscriptionDeliveryType`

Throws

	WebObjectsException
WebObjectsException

public abstract SimpleList getSubscriptions (WebSubscriptionsFilter filter, int blockBegin, int blockCount)

Returns a SimpleList collection of WebSubscription objects to which this particular user is subscribed to, from a specified begin block, up to a specified block count. These results will be filtered by the passed in WebSubscriptionsFilter

Parameters

filter	`WebSubscriptionsFilter` to restrict the results of this call. A blank filter can be retrieved from `getNewSubscriptionsFilter()`
blockBegin	, the starting count of subscription, it is 0-based index which means set it N will return subscriptions from the (N+1)th subscription.
blockCount	, block size for the incremental fetch of subscription. If set it 0, will return all subscriptions from the starting count

Returns

SimpleList of WebSubscription objects

Throws

	WebObjectsException
WebObjectsException

public abstract SimpleList getSubscriptions (int deliveryMode, int blockBegin, int blockCount)

Returns a SimpleList collection of WebSubscription objects to which this particular user is subscribed to, for a specified delivery mode, from a specified begin block, up to a specified block count.

Parameters

deliveryMode	, from `EnumDSSXMLSubscriptionDeliveryType`
blockBegin	, the starting count of subscription, it is 0-based index which means set it N will return subscriptions from the (N+1)th subscription.
blockCount	, block size for the incremental fetch of subscription. If set it 0, will return all subscriptions from the starting count

Throws

	WebObjectsException
WebObjectsException

public abstract boolean isEnabled ()

Returns whether the user is enabled or not.

Returns

True if the user is enabled, false otherwise.

public abstract void setEnabled (boolean isEnabled)

Sets the user to be enabled/disabled.

Parameters

isEnabled	This should be whether the user should be enabled or not.

public abstract void setLoginName (String loginName)

Sets the login name of the user.

Parameters

loginName	The login name to use for the user.

public abstract void setNewObjectID (String newObjectID)

set the id used to create a new user, the id would be used as the id of the user after saving in MD. It can't be called from an existing user.

Interfaces

WebUser

Class Overview

Summary

Public Methods

public abstract void createProfile ()

Throws

public abstract void deleteProfile ()

Throws

public abstract WebSubscriptionUserAddresses getAddresses ()

Throws

public abstract WebSubscriptionContacts getContacts ()

Returns

Throws

public abstract String getDefaultEmailAddress ()

Throws

public abstract String getLoginName ()

Returns

public abstract WebNTLoginInfo getNTLoginInfo ()

Returns

public abstract WebFolder getProfile ()

Returns

Throws

public abstract WebRDBMSLoginInfo getRDBMSLoginInfo ()

Returns

public abstract WebStandardLoginInfo getStandardLoginInfo ()

Returns

public abstract SimpleList getSubscriptions (int deliveryMode)

Parameters

Throws

public abstract SimpleList getSubscriptions (WebSubscriptionsFilter filter, int blockBegin, int blockCount)

Parameters

Returns

Throws

public abstract SimpleList getSubscriptions (int deliveryMode, int blockBegin, int blockCount)

Parameters

Throws

public abstract boolean isEnabled ()

Returns

public abstract void setEnabled (boolean isEnabled)

Parameters

public abstract void setLoginName (String loginName)

Parameters

public abstract void setNewObjectID (String newObjectID)