Package step.repository.alm.otaclient

Interface IGroupingManager

  • All Superinterfaces:
    com4j.Com4jObject
    public interface IGroupingManager
extends com4j.Com4jObject
    Provides services for grouping.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clear()
      Deletes the data from the GroupItem list in memory.
      com4j.Com4jObject filter()
      A TDFilter object representing the filtering criteria for the GroupManager.
      void filter​(com4j.Com4jObject pVal)
      A TDFilter object representing the filtering criteria for the GroupManager.
      int group​(String name)
      The grouping criteria.
      void group​(String name, int pVal)
      The grouping criteria.
      IList groupList()
      The list of top-level GroupItem objects.
      Object groupList​(int index)  
      boolean isClear()
      Checks if the GroupingManager contains any data.
      IList itemList()
      The list of references to the members of the group.
      Object itemList​(int index)  
      void refresh()
      Fetches the GroupList according to the Filter and Group values, overwriting the list in memory.
      String text()
      The text representation of the grouping criteria.
      void text​(String pVal)
      The text representation of the grouping criteria.

      • Methods inherited from interface com4j.Com4jObject

        advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

    • Method Detail

      • filter

        com4j.Com4jObject filter()

        A TDFilter object representing the filtering criteria for the GroupManager.

        Getter method for the COM property "Filter"

        Returns:
        Returns a value of type com4j.Com4jObject

      • filter

        void filter​(com4j.Com4jObject pVal)

        A TDFilter object representing the filtering criteria for the GroupManager.

        Setter method for the COM property "Filter"

        Parameters:
        pVal - Mandatory com4j.Com4jObject parameter.

      • group

        int group​(String name)

        The grouping criteria.

        Getter method for the COM property "Group"

        Parameters:
        name - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type int

      • group

        void group​(String name,
           int pVal)

        The grouping criteria.

        Setter method for the COM property "Group"

        Parameters:
        name - Mandatory java.lang.String parameter.
        pVal - Mandatory int parameter.

      • groupList

        IList groupList()

        The list of top-level GroupItem objects.

        Returns:
        Returns a value of type otaclient.IList

      • groupList

        Object groupList​(int index)

      • itemList

        IList itemList()

        The list of references to the members of the group.

        Returns:
        Returns a value of type otaclient.IList

      • itemList

        Object itemList​(int index)

      • refresh

        void refresh()

        Fetches the GroupList according to the Filter and Group values, overwriting the list in memory.

      • clear

        void clear()

        Deletes the data from the GroupItem list in memory.

      • isClear

        boolean isClear()

        Checks if the GroupingManager contains any data. True if there is no data.

        Returns:
        Returns a value of type boolean

      • text

        String text()

        The text representation of the grouping criteria.

        Getter method for the COM property "Text"

        Returns:
        Returns a value of type java.lang.String

      • text

        void text​(String pVal)

        The text representation of the grouping criteria.

        Setter method for the COM property "Text"

        Parameters:
        pVal - Mandatory java.lang.String parameter.