Package com.microstrategy.web.objects

Interface WebPropertyGroup

  • public interface WebPropertyGroup
    WebPropertyGroup represents a collection of WebPropertySet objects.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Enumeration elements()
      Returns an Enumeration of the collection of WebPropertySet objects inside the group.
      WebPropertySet findItemByID​(java.lang.String dssID)
      Returns the WebPropertySet object according to the specified DSSID.
      WebPropertySet findItemByName​(java.lang.String propertySetName)
      Returns the WebPropertySet object according to the specified name.
      WebPropertySet get​(int index)
      Returns the WebPropertySet object according to the index.
      WebPropertySet getItemByID​(java.lang.String dssID)
      Returns the WebPropertySet object according to the specified DSSID.
      WebPropertySet getItemByName​(java.lang.String propertySetName)
      Returns the WebPropertySet object according to the specified name.
      boolean hasItemByName​(java.lang.String propertySetName)  
      boolean isEmpty()
      Returns true if the group has no WebPropertySet object, else return false.
      int size()
      Returns the size of the group, the number of WebPropertySet objects inside the group.

    • Method Detail

      • get

        WebPropertySet get​(int index)
            throws java.lang.IndexOutOfBoundsException
        Returns the WebPropertySet object according to the index.
        Parameters:
        index - the 0-based index
        Returns:
        The WebPropertySet object according to the index.
        Throws:
        java.lang.IndexOutOfBoundsException - If the index is less than 0 or greater than the size of the group, an exception of IndexOutOfBoundsException will be thrown.

      • isEmpty

        boolean isEmpty()
        Returns true if the group has no WebPropertySet object, else return false.
        Returns:
        True if the WebPropertyGroup has no WebPropertySet object, else false.

      • size

        int size()
        Returns the size of the group, the number of WebPropertySet objects inside the group.
        Returns:
        The size of this WebPropertyGroup.

      • elements

        java.util.Enumeration elements()
        Returns an Enumeration of the collection of WebPropertySet objects inside the group.
        Returns:
        An Enumeration of the WebPropertySet objects inside the WebPropertyGroup.

      • getItemByName

        WebPropertySet getItemByName​(java.lang.String propertySetName)
                      throws java.lang.IllegalArgumentException
        Returns the WebPropertySet object according to the specified name.
        Parameters:
        propertySetName - the name of the searching propertySet
        Returns:
        The WebPropertySet WebPropertySet object according to the name.
        Throws:
        java.lang.IllegalArgumentException - If there is no propertySet in this propertyGroup whose name is the same as the input parameter, an exception of IllegalArgumentException will be thrown.

      • getItemByID

        WebPropertySet getItemByID​(java.lang.String dssID)
                    throws java.lang.IllegalArgumentException
        Returns the WebPropertySet object according to the specified DSSID.
        Parameters:
        dssID - The DSSID of the searching propertySet.
        Returns:
        The WebPropertySet object according to the DSSID.
        Throws:
        java.lang.IllegalArgumentException - If there is no propertySet in this propertyGroup whose name is the same as the input parameter, an exception of IllegalArgumentException will be thrown.

      • hasItemByName

        boolean hasItemByName​(java.lang.String propertySetName)
        Since:
        MicroStrategy Web 8.0.0

      • findItemByName

        WebPropertySet findItemByName​(java.lang.String propertySetName)
        Returns the WebPropertySet object according to the specified name. Null is returned if object does not exist.
        Parameters:
        propertySetName - the name of the searching propertySet
        Returns:
        The WebPropertySet WebPropertySet object according to the name.
        Since:
        MicroStrategy Web 8.0.0

      • findItemByID

        WebPropertySet findItemByID​(java.lang.String dssID)
        Returns the WebPropertySet object according to the specified DSSID. Null is returned if object does not exist.
        Parameters:
        dssID - The DSSID of the searching propertySet.
        Returns:
        The WebPropertySet object according to the DSSID.
        Since:
        MicroStrategy Web 8.0.0