org.squashtest.tm.domain.tree

Interface TreeLibraryNode

All Superinterfaces:

Identified, TreeVisitable

All Known Implementing Classes:

CustomReportLibraryNode, GenericTreeLibraryNode

public interface TreeLibraryNode
extends TreeVisitable, Identified

Interface for a tree node without data. The main goal of this API is to separate concern between a tree node and the entity referenced by this tree node. By design, a tree node and an entity have a 1:1 relationship.

Author:

jthebault

Method Summary

Methods

Modifier and Type	Method and Description
void	addChild(TreeLibraryNode treeLibraryNode)
List<TreeLibraryNode>	getChildren()
TreeEntity	getEntity()
long	getEntityId()
TreeEntityDefinition	getEntityType()
GenericTreeLibrary	getLibrary()
String	getName()
TreeLibraryNode	getParent()
boolean	hasContent()
void	isCoherentWithEntity() Check if a CustomReportLibraryNode is consistent with it's linked TreeEntity.
void	removeChild(TreeLibraryNode treeLibraryNode)
void	renameNode(String newName) Rename a CustomReportLibraryNode.
void	setEntity(TreeEntity treeEntity)
void	setEntityType(CustomReportTreeDefinition entityType)
void	setName(String name) Don't forget to update ENTITY name.
void	setParent(TreeLibraryNode parent)

Methods inherited from interface org.squashtest.tm.domain.tree.TreeVisitable

accept

Methods inherited from interface org.squashtest.tm.domain.Identified

getId

Method Detail

getName

String getName()

setName

void setName(String name)

Don't forget to update ENTITY name. Name is denormalized to avoid complex inject/request each time we need the name of an entity. Please use CustomReportLibraryNode.renameNode(String) that double check all constraint for you.

Parameters:

name -

getEntityId

long getEntityId()

setEntityType

void setEntityType(CustomReportTreeDefinition entityType)

getEntity

TreeEntity getEntity()

setEntity

void setEntity(TreeEntity treeEntity)

getEntityType

TreeEntityDefinition getEntityType()

getParent

TreeLibraryNode getParent()

setParent

void setParent(TreeLibraryNode parent)

getChildren

List<TreeLibraryNode> getChildren()

getLibrary

GenericTreeLibrary getLibrary()

addChild

void addChild(TreeLibraryNode treeLibraryNode)
              throws UnsupportedOperationException,
                     IllegalArgumentException,
                     NameAlreadyInUseException

Throws:

UnsupportedOperationException

IllegalArgumentException

NameAlreadyInUseException

removeChild

void removeChild(TreeLibraryNode treeLibraryNode)

isCoherentWithEntity

void isCoherentWithEntity()

Check if a CustomReportLibraryNode is consistent with it's linked TreeEntity. Throws IllegalArgumentException if not, as user action haven't any way to create this kind of inconsistency.

hasContent

boolean hasContent()

renameNode

void renameNode(String newName)

Rename a CustomReportLibraryNode. Will also take care of renaming the linked TreeEntity.

Parameters:

newName -