com.edorasware.commons.core.entity

Class WorkObjectDefinition<T extends WorkObjectDefinitionId,P extends Id>

java.lang.Object

com.edorasware.commons.core.entity.Entity<T,P>

com.edorasware.commons.core.entity.DomainObjectDefinition<T,P>

com.edorasware.commons.core.entity.WorkObjectDefinition<T,P>

Type Parameters:

T - The type of the id/externalId

P - The type of the providerId

All Implemented Interfaces:

HierarchicalEntity<WorkObjectDefinitionId,T>, Identifiable<T>

Direct Known Subclasses:

AnyWorkObjectDefinition

public abstract class WorkObjectDefinition<T extends WorkObjectDefinitionId,P extends Id>
extends DomainObjectDefinition<T,P>
implements HierarchicalEntity<WorkObjectDefinitionId,T>

Base class for all definitions of work objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkObjectDefinition.WorkObjectDefinitionBuilder<T extends WorkObjectDefinitionId,P extends Id,E extends WorkObjectDefinition<T,P>,SELF extends WorkObjectDefinition.WorkObjectDefinitionBuilder<T,P,E,SELF>>
protected static class	WorkObjectDefinition.WorkObjectDefinitionData Data container that holds the state of a work object definition.

Nested classes/interfaces inherited from class com.edorasware.commons.core.entity.DomainObjectDefinition

DomainObjectDefinition.DomainObjectDefinitionBuilder<T extends EntityId,P extends Id,E extends DomainObjectDefinition<T,P>,SELF extends DomainObjectDefinition.DomainObjectDefinitionBuilder<T,P,E,SELF>>, DomainObjectDefinition.DomainObjectDefinitionData<T extends EntityId,P extends Id>

Nested classes/interfaces inherited from class com.edorasware.commons.core.entity.Entity

Entity.EntityBuilder<T extends EntityId,P extends Id,E extends Entity<T,P>,SELF extends Entity.EntityBuilder<T,P,E,SELF>>, Entity.EntityData<T extends EntityId,P extends Id>

Nested classes/interfaces inherited from interface com.edorasware.commons.core.entity.HierarchicalEntity

HierarchicalEntity.HierarchicalEntityBuilder<T extends HierarchicalEntityId,SELF extends HierarchicalEntity.HierarchicalEntityBuilder<T,SELF>>

Field Summary

Fields

Modifier and Type	Field and Description
protected WorkObjectDefinition.WorkObjectDefinitionData	workObjectDefinitionData

Fields inherited from class com.edorasware.commons.core.entity.DomainObjectDefinition

domainObjectDefinitionData

Fields inherited from class com.edorasware.commons.core.entity.Entity

entityData

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WorkObjectDefinition(Entity.EntityData<T,P> entityData, DomainObjectDefinition.DomainObjectDefinitionData<T,P> domainObjectDefinitionData, WorkObjectDefinition.WorkObjectDefinitionData workObjectDefinitionData)

Method Summary

Modifier and Type	Method and Description
WorkObjectDefinitionId	getParentId() Returns the id of the parent entity.
<T extends WorkObjectDefinitionId> T	getParentId(Class<T> expectedParentType) Returns the first parent of the entity that is of the expected type when walking up the path from the immediate parent to the root.
List<? extends WorkObjectDefinitionId>	getPath() Returns the path of the hierarchy to which the entity belongs.
WorkObjectDefinitionId	getRootId() Returns the id of the root entity.
<T extends WorkObjectDefinitionId> T	getTopMostParentId(Class<T> expectedParentType) Returns the topmost parent of the entity that is of the expected type when walking up the path from the immediate parent to the root.
boolean	hasParent() Returns true if the entity has a parent.
String	toString()

Methods inherited from class com.edorasware.commons.core.entity.DomainObjectDefinition

getExternalVersion, getKey, getLocalProperties, getLocalProperties, getLocalPropertiesMap, getLocalPropertiesMap, getLocalProperty, getLocalPropertyValue, getLocalPropertyValue, getProperties, getProperties, getPropertiesMap, getPropertiesMap, getProperty, getPropertyValue, getPropertyValue, getResourceString, getValidFrom, getValidTo, getVersion, hasLocalProperty, hasLocalProperty, hasProperty, hasProperty

Methods inherited from class com.edorasware.commons.core.entity.Entity

getCreationTime, getDescription, getExternalId, getGlobalId, getId, getModificationCreatorId, getModificationUpdaterId, getModificationVersion, getName, getProviderId, getTenantId, getType, getUpdateTime

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getId

Field Detail

workObjectDefinitionData

protected final WorkObjectDefinition.WorkObjectDefinitionData workObjectDefinitionData

Constructor Detail

WorkObjectDefinition

protected WorkObjectDefinition(Entity.EntityData<T,P> entityData,
                               DomainObjectDefinition.DomainObjectDefinitionData<T,P> domainObjectDefinitionData,
                               WorkObjectDefinition.WorkObjectDefinitionData workObjectDefinitionData)

Method Detail

getPath

public List<? extends WorkObjectDefinitionId> getPath()

Description copied from interface: HierarchicalEntity

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.

Specified by:

getPath in interface HierarchicalEntity<WorkObjectDefinitionId,T extends WorkObjectDefinitionId>

Returns:

the hierarchy path

getRootId

public WorkObjectDefinitionId getRootId()

Description copied from interface: HierarchicalEntity

Returns the id of the root entity.

Specified by:

getRootId in interface HierarchicalEntity<WorkObjectDefinitionId,T extends WorkObjectDefinitionId>

Returns:

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

hasParent

public boolean hasParent()

Description copied from interface: HierarchicalEntity

Returns true if the entity has a parent.

Specified by:

hasParent in interface HierarchicalEntity<WorkObjectDefinitionId,T extends WorkObjectDefinitionId>

Returns:

true if the entity has a parent

getParentId

public WorkObjectDefinitionId getParentId()

Description copied from interface: HierarchicalEntity

Returns the id of the parent entity.

Specified by:

getParentId in interface HierarchicalEntity<WorkObjectDefinitionId,T extends WorkObjectDefinitionId>

Returns:

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

getParentId

public <T extends WorkObjectDefinitionId> T getParentId(Class<T> expectedParentType)

Description copied from interface: HierarchicalEntity

Returns the first parent of the entity that is of the expected type when walking up the path from the immediate parent to the root.

Specified by:

getParentId in interface HierarchicalEntity<WorkObjectDefinitionId,T extends WorkObjectDefinitionId>

Type Parameters:

T - the type of the parent class

Parameters:

expectedParentType - the expected parent type

Returns:

the first parent of the entity of the expected type, or null

getTopMostParentId

public <T extends WorkObjectDefinitionId> T getTopMostParentId(Class<T> expectedParentType)

Description copied from interface: HierarchicalEntity

Returns the topmost parent of the entity that is of the expected type when walking up the path from the immediate parent to the root.

Specified by:

getTopMostParentId in interface HierarchicalEntity<WorkObjectDefinitionId,T extends WorkObjectDefinitionId>

Type Parameters:

T - the type of the parent class

Parameters:

expectedParentType - the expected parent type

Returns:

the topmost parent of the entity of the expected type, or null

toString

public String toString()

Specified by:

toString in class Entity<T extends WorkObjectDefinitionId,P extends Id>