Package com.microstrategy.web.objects.admin.users

Interface WebUser

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

      • getSubscriptions

        SimpleList getSubscriptions​(int deliveryMode,
                            int blockBegin,
                            int blockCount)
                     throws WebObjectsException
        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
        Since:
        MicroStrategy Web 9.0.0

      • 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

      • getDefaultEmailAddress

        java.lang.String getDefaultEmailAddress​(boolean populate)
                                 throws WebObjectsException
        Get the default email address of the user.
        Parameters:
        populate - control whether generate a call on the iServer to get email address. If it is true and the user is not generated from a quick search result, there will be a call made on the IServer to get the email address. otherwise false, directly return default email address.
        Throws:
        WebObjectsException - if you are getting the result from quick search, you can ignore this exception as it can not happen

      • getDefaultTimezone

        WebObjectInfo getDefaultTimezone()
        Get default timezone of user.
        Returns:
        timezone objectWebObjectInfo
        Since:
        MicroStrategy 11.3.4

      • setDefaultTimezone

        void setDefaultTimezone​(WebObjectInfo defaultTimezone)
        Set default timezone of user.
        Parameters:
        defaultTimezone - timezone object
        Since:
        MicroStrategy 11.3.4

      • setDefaultTimezoneId

        void setDefaultTimezoneId​(java.lang.String defaultTimezoneId)
                   throws WebObjectsException
        Set default timezone id of user.
        Parameters:
        defaultTimezoneId - timezone object id
        Throws:
        WebObjectsException
        Since:
        MicroStrategy 11.3.4

      • removeDefaultTimezone

        void removeDefaultTimezone()
        Clear user timezone.
        Since:
        MicroStrategy 11.3.4

      • validateDefaultTimezone

        void validateDefaultTimezone​(java.lang.String defaultTimezoneId)
                      throws WebObjectsException
        Validate timezone subtype and use ACL.
        Parameters:
        defaultTimezoneId - timezone object id
        Throws:
        WebObjectsException
        Since:
        MicroStrategy 22.01