Package com.polarion.alm.tracker.model

Interface IModule.IStructureNode

All Superinterfaces:
IChangeGenerator, IChangeListener, IHasCustomValues, IHasValues, IStructure
Enclosing interface:
IModule
public static interface IModule.IStructureNode extends IStructure

  • Field Details

  • Method Details

    • getWorkItem

      IWorkItem getWorkItem()
      Returns:
      Work Item represented by this node, never returns null except virtual root node.

    • getParent

      IModule.IStructureNode getParent()
      Returns:
      parent node.

    • getChildren

      List<IModule.IStructureNode> getChildren()
      Unmodifiable list of child nodes. For modifications of the tree use the addChild methods which remove the child from children of previous parent. There is no "removeChild" because it is not possible to remove work item from the module this way. To remove work item use the removeWorkItem method of the module.

    • addChild

      void addChild(IModule.IStructureNode child)
      Each node can be child only of one parent, so adding it as a child of new parent removes it from children of previous parent.

      When adding child to Live Document the child might be added to different parent (but in the same subtree). This is because the document flow is retained and it is not possible for a heading to have plain child Work Items in the list of children after other headings (headings are always last).

      Parameters:
      child - - must be from the same module, it is not supported to move WIs between modules this way

    • addChild

      void addChild(IModule.IStructureNode child, int index)
      Each node can be child only of one parent, so adding it as a child of new parent removes it from children of previous parent.

      When adding child to Live Document the child might be added to different parent (but in the same subtree). This is because the document flow is retained and it is not possible for a heading to have plain child Work Items in the list of children after other headings (headings are always last).

      Parameters:
      child - - must be from the same module, it is not supported to move WIs between modules this way
      index - index to the list of children (if the old and new parent is the same then moved work item is not counted)

    • accept

      void accept(IModule.IStructureNode.IVisitor visitor)
      Accepts the visitor on this node and if the accept method of the visitor returns true, than calls accept method on all children.
      Parameters:
      visitor -

    • select

      IModule.IStructureNode select(IModule.IStructureNode.ISelector selector)
      Return node for which the select method of the selector returns true.
      Parameters:
      selector -

    • getOutlineNumber

      String getOutlineNumber()
      Returns outline number of this node. If the number is not defined, either empty string or null could be returned.
      Since:
      3.4

    • isExternal

      boolean isExternal()
      Since:
      3.6.0

    • getLayout

      int getLayout()
      Since:
      3.8.3

    • getModule

      IModule getModule()
      Since:
      3.6.0

    • moveNodeAfter

      void moveNodeAfter(IModule.IStructureNode structureNode)
      Since:
      3.6.3

    • moveNodeBefore

      void moveNodeBefore(IModule.IStructureNode structureNode)
      Since:
      3.6.3

    • moveNodeAsFirstChild

      void moveNodeAsFirstChild(IModule.IStructureNode structureNode)
      Since:
      3.6.3

    • moveNodeAsLastChild

      void moveNodeAsLastChild(IModule.IStructureNode structureNode)
      Since:
      3.6.3

    • updateWorkItemLayout

      void updateWorkItemLayout(int layout)
      Since:
      3.8.3

    • changeNodeTypeToWorkItem

      int changeNodeTypeToWorkItem()
      Changes the representation of the structure node on the Home Page content of the Module from HEADING type to the WORK ITEM type (e.g., Requirement).
      Returns:
      level of Work Item
      Since:
      3.20.2

    • updateWorkItemLevel

      void updateWorkItemLevel(int level)
      Updates the level of Work Item.
      Parameters:
      level - the Work Item's level
      Since:
      3.20.2

    • removeWorkItemLevel

      void removeWorkItemLevel()
      Removes the level attribute from the corresponding node.
      Since:
      3.21.1

    • decreaseWorkItemLevel

      void decreaseWorkItemLevel()
      Decrease Level of Work Item by 1.
      Since:
      3.21.1

    • changeNodeTypeToHeading

      void changeNodeTypeToHeading()
      Changes the representation of the structure node on the Home Page content of the Module from WORK ITEM type (e.g., Requirement) to the HEADING type.
      Since:
      3.21.1