Interface WebPrivilegeCategories

  • All Known Implementing Classes:
    WebSecurityRolePrivilegeCategoriesImpl

    public interface WebPrivilegeCategories
    This interface represents a set of privileges categorized by a custom category type. It represents a collection of WebPrivilegeCategory objects, each of which correspond to a single category type. This class has methods to get items by either index or category type. Note that these categories can be either custom categories set up by the user via an XML configuration file, or if obtained from the LicenseSource interface, will correspond to the license types in EnumDSSXMLLicenseTypes.
    Since:
    MicroStrategy Web 7.5.2
    • Method Detail

      • size

        int size()
        Returns the number of items in the collection.
        Returns:
        The size of the collection.
      • get

        WebPrivilegeCategory get​(int index)
        Returns the item at the given index in the collection.
        Parameters:
        index - The index of the item in the collection.
        Returns:
        A WebPrivilegeCategory object with the given index.
      • getItemByType

        WebPrivilegeCategory getItemByType​(int type)
        Returns the item in the collection with the given category type.
        Parameters:
        type - The category type to retrieve.
        Returns:
        The WebPrivilegeCategory representing the given category type.
      • getTypesAvailable

        int[] getTypesAvailable()
        Returns the list of types available in the collection.
        Returns:
        An int array containing the list of types in the collection.