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 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, 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 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)
Returns a SimpleList collection of WebSubscription objects to which this particular user is subscribed to, for a specified delivery mode.
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
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite
From interface com.microstrategy.web.objects.admin.users.WebUserEntity

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.

public abstract WebSubscriptionContacts getContacts ()

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

Returns

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, 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 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
Throws
WebObjectsException
WebObjectsException

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