Interface WebUser
-
- All Superinterfaces:
EnumWebPersistableState
,KeyedObject
,Persistable
,WebDisplayUnit
,WebFeatures
,WebObjectInfo
,WebPromptSite
,WebUserEntity
public interface WebUser extends WebUserEntity
The WebUser interface represents user-specific account information. The WebUser interface is obtained by casting theWebUserEntity
interface. This interface contains only those properties which apply to users. Any properties which apply to both users and groups are inherited from theWebUserEntity
interface.- Since:
- MicroStrategy Web 7.5.2
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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.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.WebSubscriptionUserAddresses
getAddresses()
Returns aSimpleList
collection ofWebSubscriptionAddress
objects for the current user for all the delivery modes.WebSubscriptionContacts
getContacts()
Returns aWebSubscriptionContacts
interface, which is a collection of contacts that is associated to the current user entity.java.lang.String
getDefaultEmailAddress()
Get the default email address of the user.java.lang.String
getLoginName()
Returns the login name of the user.WebNTLoginInfo
getNTLoginInfo()
Returns an interface which can be used to read and write NT-authentication-related information about the user.WebFolder
getProfile()
Find the profile folder for the particular user.WebRDBMSLoginInfo
getRDBMSLoginInfo()
Returns an interface which can be used to read and write RDBMS-related information about the user.WebStandardLoginInfo
getStandardLoginInfo()
Returns an interface which can be used to read and write properties for the user relating to standard authentication.SimpleList
getSubscriptions(int deliveryMode)
Returns aSimpleList
collection ofWebSubscription
objects to which this particular user is subscribed to, for a specified delivery mode.SimpleList
getSubscriptions(int deliveryMode, int blockBegin, int blockCount)
Returns aSimpleList
collection ofWebSubscription
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.SimpleList
getSubscriptions(WebSubscriptionsFilter filter, int blockBegin, int blockCount)
Returns aSimpleList
collection ofWebSubscription
objects to which this particular user is subscribed to, from a specified begin block, up to a specified block count.boolean
isEnabled()
Returns whether the user is enabled or not.void
setEnabled(boolean isEnabled)
Sets the user to be enabled/disabled.void
setLoginName(java.lang.String lName)
Sets the login name of the user.void
setNewObjectID(java.lang.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.-
Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
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
-
Methods inherited from interface com.microstrategy.web.objects.admin.users.WebUserEntity
getAccessibleProjects, getAllPrivileges, getAnalysisQuota, getAncestorGroups, getFullName, getLDAPLoginInfo, getLocalPrivileges, getParents, getSecurityFilters, getSecurityRoles, getSimpleSecurityPluginLoginInfo, getSourceType, hasInheritedSecurityRoles, isGroup, removeAnalysisQuota, setAnalysisQuota, setFullName
-
-
-
-
Method Detail
-
isEnabled
boolean isEnabled()
Returns whether the user is enabled or not.- Returns:
- True if the user is enabled, false otherwise.
-
setEnabled
void setEnabled(boolean isEnabled)
Sets the user to be enabled/disabled.- Parameters:
isEnabled
- This should be whether the user should be enabled or not.
-
getRDBMSLoginInfo
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.
-
getLoginName
java.lang.String getLoginName()
Returns the login name of the user.- Returns:
- The current login name of the user.
-
setLoginName
void setLoginName(java.lang.String lName)
Sets the login name of the user.- Parameters:
lName
- The login name to use for the user.
-
getNTLoginInfo
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.
-
getStandardLoginInfo
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.
-
getContacts
WebSubscriptionContacts getContacts() throws WebObjectsException
Returns aWebSubscriptionContacts
interface, which is a collection of contacts that is associated to the current user entity.- Returns:
- A
WebSubscriptionContacts
object - Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
getAddresses
WebSubscriptionUserAddresses getAddresses() throws WebObjectsException
Returns aSimpleList
collection ofWebSubscriptionAddress
objects for the current user for all the delivery modes. This collection is read-only.- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
getSubscriptions
SimpleList getSubscriptions(int deliveryMode) throws WebObjectsException
Returns aSimpleList
collection ofWebSubscription
objects to which this particular user is subscribed to, for a specified delivery mode.- Parameters:
deliveryMode
- , fromEnumDSSXMLSubscriptionDeliveryType
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
getSubscriptions
SimpleList getSubscriptions(int deliveryMode, int blockBegin, int blockCount) throws WebObjectsException
Returns aSimpleList
collection ofWebSubscription
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
- , fromEnumDSSXMLSubscriptionDeliveryType
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
- Since:
- MicroStrategy Web 9.0.0
-
getSubscriptions
SimpleList getSubscriptions(WebSubscriptionsFilter filter, int blockBegin, int blockCount) throws WebObjectsException
Returns aSimpleList
collection ofWebSubscription
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 inWebSubscriptionsFilter
- Parameters:
filter
-WebSubscriptionsFilter
to restrict the results of this call. A blank filter can be retrieved fromWebSubscriptionsSource.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
ofWebSubscription
objects- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.1
-
createProfile
void createProfile() throws WebObjectsException
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
- Since:
- MicroStrategy Web 9.0.0
-
deleteProfile
void deleteProfile() throws WebObjectsException
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
- Since:
- MicroStrategy Web 9.0.0
-
getProfile
WebFolder getProfile() throws WebObjectsException
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
- Since:
- MicroStrategy Web 9.0.0
-
setNewObjectID
void setNewObjectID(java.lang.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.- Parameters:
newObjectID
-- Since:
- Cloud Pro
-
getDefaultEmailAddress
java.lang.String getDefaultEmailAddress() throws WebObjectsException
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:
WebObjectsException
- if you are getting the result from quick search, you can ignore this exception as it can not happen
-
-