com.edorasware.commons.core.entity

Class Entity<T extends EntityId,P extends Id>

java.lang.Object

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

Type Parameters:

T - The type of the id/externalId

P - The type of the providerId

All Implemented Interfaces:

Identifiable<T>

Direct Known Subclasses:

Beat, DomainObject, DomainObjectDefinition

public abstract class Entity<T extends EntityId,P extends Id>
extends Object
implements Identifiable<T>

Base class for all entities.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Entity.EntityBuilder<T extends EntityId,P extends Id,E extends Entity<T,P>,SELF extends Entity.EntityBuilder<T,P,E,SELF>>
protected static class	Entity.EntityData<T extends EntityId,P extends Id> Data container that holds the state of an entity.

Field Summary

Fields

Modifier and Type	Field and Description
protected Entity.EntityData<T,P>	entityData

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Entity(Entity.EntityData<T,P> entityData)

Method Summary

Modifier and Type	Method and Description
Date	getCreationTime() Returns the time the entity was created.
String	getDescription() Returns the description of the entity.
T	getExternalId() Returns the external id of the entity.
GlobalId	getGlobalId() Returns the global id of the entity.
T	getId() Returns the id of the entity.
UserId	getModificationCreatorId() Returns the id of the user who created the entity.
UserId	getModificationUpdaterId() Returns the id of the user who last modified the entity.
long	getModificationVersion() Returns the modification version of the entity.
String	getName() Returns the name of the entity.
P	getProviderId() Returns the id of the provider that contributed the entity.
TenantId	getTenantId() Returns the id of the tenant to whom the entity belongs.
Type	getType() Returns the concrete type of the entity.
Date	getUpdateTime() Returns the time the entity was last updated.
abstract String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

entityData

protected final Entity.EntityData<T extends EntityId,P extends Id> entityData

Constructor Detail

Entity

protected Entity(Entity.EntityData<T,P> entityData)

Method Detail

getId

public T getId()

Returns the id of the entity. The id is typically given by the persistence component of the system.

Specified by:

getId in interface Identifiable<T extends EntityId>

Returns:

the id of the entity

getGlobalId

public GlobalId getGlobalId()

Returns the global id of the entity. The id identifies the same object in different tenants and is typically either given by the persistence component of the system or set when the entity is copied from another tenant or system.

Returns:

the global id of the entity

getExternalId

public T getExternalId()

Returns the external id of the entity. The external id is typically given by the contributor of the entity.

Returns:

the external id of the entity

getProviderId

public P getProviderId()

Returns the id of the provider that contributed the entity.

Returns:

the id of the provider of the entity

getTenantId

public TenantId getTenantId()

Returns the id of the tenant to whom the entity belongs.

Returns:

the id of the tenant of the entity

getName

public String getName()

Returns the name of the entity.

Returns:

the name of the entity

getDescription

public String getDescription()

Returns the description of the entity.

Returns:

the description of the entity

getCreationTime

public Date getCreationTime()

Returns the time the entity was created.

Returns:

the creation time of the entity

getUpdateTime

public Date getUpdateTime()

Returns the time the entity was last updated.

Returns:

the last update time of the entity

getType

public Type getType()

Returns the concrete type of the entity. The type discriminator is useful when operating on abstract entities but still wanting to know what the concrete entity type is, e.g. to display this information in a GUI.

Returns:

the concrete type of the entity

getModificationVersion

public long getModificationVersion()

Returns the modification version of the entity. The complete state of an entity can be uniquely identified by its modification version.

Returns:

the modification version of the entity

getModificationCreatorId

public UserId getModificationCreatorId()

Returns the id of the user who created the entity.

Returns:

the id of the creator of the entity

getModificationUpdaterId

public UserId getModificationUpdaterId()

Returns the id of the user who last modified the entity.

Returns:

the id of the last updater of the entity

toString

public abstract String toString()

Overrides:

toString in class Object