com.edorasware.commons.core.entity

Class Entity

java.lang.Object

com.edorasware.commons.core.entity.Entity

All Implemented Interfaces:

Identifiable

Direct Known Subclasses:

AnyWorkObject, AnyWorkObjectDefinition

public abstract class Entity
extends Object
implements Identifiable

Base class for all entities.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Entity.EntityBuilder<E extends Entity,SELF extends Entity.EntityBuilder<E,SELF>>

Method Summary

Modifier and Type	Method and Description
Instant	getCreationTime() Returns the time the entity was created.
String	getExternalId() Returns the external id of the entity.
String	getGlobalId() Returns the global id of the entity.
String	getId() Returns the id of the entity.
String	getModificationCreatorId() Returns the id of the user who created the entity.
String	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.
String	getProviderId() Returns the id of the provider that contributed the entity.
String	getTenantId() Returns the id of the tenant to whom the entity belongs.
String	getType() Returns the concrete type of the entity.
Instant	getUpdateTime() Returns the time the entity was last updated.
abstract String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getId

public String 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

Returns:

the id of the entity

getGlobalId

public String 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 String 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 String getProviderId()

Returns the id of the provider that contributed the entity.

Returns:

the id of the provider of the entity

getTenantId

public String 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

getCreationTime

public Instant getCreationTime()

Returns the time the entity was created.

Returns:

the creation time of the entity

getUpdateTime

public Instant getUpdateTime()

Returns the time the entity was last updated.

Returns:

the last update time of the entity

getType

public String 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 String getModificationCreatorId()

Returns the id of the user who created the entity.

Returns:

the id of the creator of the entity

getModificationUpdaterId

public String 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