Package step.repository.alm.otaclient

Interface ISysTreeNode

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ISysTreeNode addNode​(java.lang.String nodeName)
      Adds a new child node.
      int attribute()
      Gets the node attribute.
      ISysTreeNode child​(int index)
      Gets a sub-folder of the current folder.
      int count()
      The number of child nodes.
      short depthType()
      The sub-tree depth type.
      ISysTreeNode father()
      The current folder's parent folder.
      ISysTreeNode findChildNode​(java.lang.String childName)
      Finds a child node by node name.
      IList findChildren​(java.lang.String pattern, boolean matchCase, java.lang.String filter)
      Finds node children according to specified search pattern.
      java.lang.String name()
      The node name.
      void name​(java.lang.String pVal)
      The node name.
      IList newList()
      Gets a list of the node's immediate children.
      java.lang.Object newList​(int index)  
      int nodeID()
      The node ID number.
      java.lang.String path()
      The folder tree path starting from the tree root.
      void post()
      Posts all changed values to the database.
      void refresh()
      Reads the saved node data, overwriting values in memory.
      void removeNode​(java.lang.Object node)
      Deletes the specified node.

      • Methods inherited from interface com4j.Com4jObject

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

    • Method Detail

      • name

        java.lang.String name()

        The node name.

        Getter method for the COM property "Name"

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

      • name

        void name​(java.lang.String pVal)

        The node name.

        Setter method for the COM property "Name"

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

      • addNode

        ISysTreeNode addNode​(java.lang.String nodeName)

        Adds a new child node.

        Parameters:
        nodeName - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type otaclient.ISysTreeNode

      • newList

        IList newList()

        Gets a list of the node's immediate children.

        Returns:
        Returns a value of type otaclient.IList

      • newList

        java.lang.Object newList​(int index)

      • nodeID

        int nodeID()

        The node ID number.

        Getter method for the COM property "NodeID"

        Returns:
        Returns a value of type int

      • attribute

        int attribute()

        Gets the node attribute.

        Getter method for the COM property "Attribute"

        Returns:
        Returns a value of type int

      • findChildNode

        ISysTreeNode findChildNode​(java.lang.String childName)

        Finds a child node by node name.

        Parameters:
        childName - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type otaclient.ISysTreeNode

      • removeNode

        void removeNode​(java.lang.Object node)

        Deletes the specified node.

        Parameters:
        node - Mandatory java.lang.Object parameter.

      • father

        ISysTreeNode father()

        The current folder's parent folder.

        Getter method for the COM property "Father"

        Returns:
        Returns a value of type otaclient.ISysTreeNode

      • child

        ISysTreeNode child​(int index)

        Gets a sub-folder of the current folder.

        Getter method for the COM property "Child"

        Parameters:
        index - Mandatory int parameter.
        Returns:
        Returns a value of type otaclient.ISysTreeNode

      • count

        int count()

        The number of child nodes.

        Getter method for the COM property "Count"

        Returns:
        Returns a value of type int

      • depthType

        short depthType()

        The sub-tree depth type.

        Getter method for the COM property "DepthType"

        Returns:
        Returns a value of type short

      • findChildren

        IList findChildren​(java.lang.String pattern,
                   @DefaultValue("0")
                   boolean matchCase,
                   @DefaultValue("")
                   java.lang.String filter)

        Finds node children according to specified search pattern.

        Parameters:
        pattern - Mandatory java.lang.String parameter.
        matchCase - Optional parameter. Default value is false
        filter - Optional parameter. Default value is ""
        Returns:
        Returns a value of type otaclient.IList

      • path

        java.lang.String path()

        The folder tree path starting from the tree root.

        Getter method for the COM property "Path"

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

      • post

        void post()

        Posts all changed values to the database.

      • refresh

        void refresh()

        Reads the saved node data, overwriting values in memory.