com.edorasware.commons.core.entity

Interface HierarchicalEntity

All Superinterfaces:

Identifiable

All Known Implementing Classes:

AnyWorkObject, AnyWorkObjectDefinition

public interface HierarchicalEntity
extends Identifiable

Entity that is structured hierarchically.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HierarchicalEntity.HierarchicalEntityBuilder<SELF extends HierarchicalEntity.HierarchicalEntityBuilder<SELF>> Builder for a HierarchicalEntity instance.

Method Summary

Modifier and Type	Method and Description
String	getParentId() Returns the id of the parent entity.
List<String>	getPath() Returns the path of the hierarchy to which the entity belongs.
String	getRootId() Returns the id of the root entity.
boolean	hasParent() Returns <i>true</i> if the entity has a parent.

Methods inherited from interface com.edorasware.commons.core.id.Identifiable

getId

Method Detail

getPath

List<String> getPath()

Returns the path of the hierarchy to which the entity belongs. The path starts with the root and ends with the entity itself, when iterating through the list from beginning to end.

Returns:

the hierarchy path

getRootId

String getRootId()

Returns the id of the root entity.

Returns:

the root entity id, if the entity is itself the root entity, the id of the entity is returned

hasParent

boolean hasParent()

Returns <i>true</i> if the entity has a parent.

Returns:

<i>true</i> if the entity has a parent

getParentId

String getParentId()

Returns the id of the parent entity.

Returns:

the parent entity id, or null if the entity has no parent