Interface WebProjectSettingsGroup


  • public interface WebProjectSettingsGroup
    WebProjectSettingsGroup is a group of WebProjectSettings collections. This is designed to contain all the project settings for a given setting type and therefore there will most likely be an instantiation for each type of project setting. As such, there will not be a single enumeration to account for all values possible valid parameters to the getItemByModuleID(int) method
    Since:
    MicroStrategy Web 9.0.0
    • Method Detail

      • size

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

        WebProjectSettingsModule get​(int i)
        Returns the setting collection at the given index in the collection. Note that the setting collections are not ordered in any way.
        Parameters:
        i - The index of the object to return.
        Returns:
        The WebProjectSettings object at the given index.
      • getItemByModuleID

        WebProjectSettingsModule getItemByModuleID​(int id)
                                            throws java.lang.IllegalArgumentException
        Returns the settings collection with the given id. The ID comes from whichever enumeration is associated with the settings type this group is used for
        Parameters:
        id - The ID of the item to return from the collection.
        Returns:
        The WebProjectSettings object with the given ID.
        Throws:
        java.lang.IllegalArgumentException - Thrown if no item with the given ID exists in the collection.
      • contains

        boolean contains​(int id)
        Returns whether an item with the given ID exists in the collection.
        Parameters:
        id - The ID of the item to search for
        Returns:
        True if the ID exists in the group, false if not.