Package com.microstrategy.web.objects.admin.licensing

Interface UserLicenseAudit

  • public interface UserLicenseAudit
    This interface represents the result of an audit operation, which is initiated by calling the auditUsers method on LicenseSource. This interface can be used to get a list of users or a count for any license type for the users which were audited.
    Since:
    MicroStrategy Web 7.5.2

    • Method Detail

      • getLicensedUsers

        LicensedUsers getLicensedUsers​(int licenseType)
        Returns the list of licensed users which use the given license.
        Parameters:
        licenseType - A value from EnumDSSXMLLicenseType which determines which license type is to be examined.
        Returns:
        The LicensedUsers collection for the given license type, which can be used to count or display the users using the license type.

      • getLicensedUsers

        LicensedUsers getLicensedUsers​(int licenseType,
                               int subset)
        Returns the list of licensed users which use the given license. This method can also allow subsetting of the users by their enabled/disabled flags.
        Parameters:
        licenseType - A value from EnumDSSXMLLicenseType which determines which license type is to be examined.
        subset - A value from EnumDSSXMLAuditUserFilter, which determines whether the list should contain enabled, disabled, or all users.
        Returns:
        The LicensedUsers collection for the given license type, which can be used to count or display the users using the license type.

      • getLicenseTypeList

        int[] getLicenseTypeList()
        Returns a list of license types in the collection with more than 0 users.
        Returns:
        An array of integers, corresponding to values in EnumDSSXMLLicenseType, which are the license types with 1 or more users in them.

      • getUnlicensedUsers

        LicensedUsers getUnlicensedUsers()
                          throws WebObjectsException
        Returns a list of users within the audited group which do not belong to any license group.
        Returns:
        A LicensedUsers collection containing those users who do not belong to any license group.
        Throws:
        WebObjectsException - Thrown if an error occurs.

      • getUnlicensedUsers

        LicensedUsers getUnlicensedUsers​(int subset)
                          throws WebObjectsException
        Returns a list of users within the audited group which do not belong to any license group. Note that this method can do subsetting based on enabled vs disabled. Note that this operation is relatively expensive with subsetting (the definition of every user object must be retrieved) and should be used with caution.
        Parameters:
        subset - The subset of objects to return, indicated by a value from EnumDSSXMLAuditUserFilter.
        Returns:
        A LicensedUsers collection containing those users who do not belong to any license group filtered by the given criteria.
        Throws:
        WebObjectsException - Thrown if an error occurs.
        Since:
        MicroStrategy Web 8.0.0