com.edorasware.commons.core.beat

Class Beat

java.lang.Object

com.edorasware.commons.core.entity.Entity<BeatId,BeatProviderId>

com.edorasware.commons.core.beat.Beat

All Implemented Interfaces:

Identifiable<BeatId>

public final class Beat
extends Entity<BeatId,BeatProviderId>

Represents a running beat.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Beat.Builder Builder for a Beat instance.

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>

Field Summary

Fields

Modifier and Type	Field and Description
static DateOperand	CREATION_TIME Allows to build predicates testing for certain beat creation time values.
static StringOperand	DESCRIPTION Allows to build predicates testing for certain description values.
static Type	ENTITY_TYPE The type that identifies a beat entity.
static BasicOperand<EventType>	EVENT_SUB_TYPE Allows to build predicates testing for certain beat event sub type values.
static BasicOperand<EventType>	EVENT_TYPE Allows to build predicates testing for certain beat event type values.
static BasicOperand<BeatId>	EXTERNAL_ID Allows to build predicates testing for certain external beat id values.
static BasicOperand<GlobalId>	GLOBAL_ID Allows to build predicates testing for certain global id values.
static BasicOperand<Long>	GLOBAL_ORDER_INDEX Allows to build predicates testing for certain beat global order index values.
static BasicOperand<BeatId>	ID Allows to build predicates testing for certain beat id values.
static StringOperand	NAME Allows to build predicates testing for certain beat name values.
static BasicOperand<BeatId>	PARENT_ID Allows to build predicates testing for certain beat parent beat id values.
static BasicOperand<BeatProviderId>	PROVIDER_ID Allows to build predicates testing for certain beat provider id values.
static BasicOperand<BeatId>	ROOT_ID Allows to build predicates testing for certain beat root beat id values.
static BasicOperand<FieldId>	SOURCE_FIELD_ID Allows to build predicates testing for certain beat source field id values.
static BasicOperand<EntityId>	SOURCE_ID Allows to build predicates testing for certain beat source id values.
static BasicOperand<TenantId>	TENANT_ID Allows to build predicates testing for certain tenant id values.
static DateOperand	UPDATE_TIME Allows to build predicates testing for certain beat update time values.

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

entityData

Method Summary

Modifier and Type	Method and Description
static Beat.Builder	builder() Creates a builder for a new beat instance.
static Beat.Builder	builder(Beat template) Creates a builder for a new beat instance and applies the given template.
static Beat.Builder	builder(BeatId id) Creates a builder for a new beat instance and applies the given id.
EventType	getEventSubType() The event sub type.
EventType	getEventType() The event type.
long	getGlobalOrderIndex() The order index across all Beats.
BeatId	getParentId() The parent id of the beat.
BeatId	getRootId() The root id of the beat.
FieldId	getSourceFieldId() The source field id.
EntityId	getSourceId() The source id.
Object	getSourceNewValue() The new value of the source.
String	getSourceNewValueString() The new value of the source represented as a string.
UserId	getSourceOldModificationUpdaterId() The former modifier of the source.
long	getSourceOldModificationVersion() The former modification version of the source.
Date	getSourceOldUpdateTime() The former update time of the source.
Object	getSourceOldValue() The former value of the source.
String	getSourceOldValueString() The former value of the source represented as a string.
String	toString()

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

Field Detail

ENTITY_TYPE

public static final Type ENTITY_TYPE

The type that identifies a beat entity.

ID

public static final BasicOperand<BeatId> ID

Allows to build predicates testing for certain beat id values.

GLOBAL_ID

public static final BasicOperand<GlobalId> GLOBAL_ID

Allows to build predicates testing for certain global id values.

EXTERNAL_ID

public static final BasicOperand<BeatId> EXTERNAL_ID

Allows to build predicates testing for certain external beat id values.

PROVIDER_ID

public static final BasicOperand<BeatProviderId> PROVIDER_ID

Allows to build predicates testing for certain beat provider id values.

TENANT_ID

public static final BasicOperand<TenantId> TENANT_ID

Allows to build predicates testing for certain tenant id values.

NAME

public static final StringOperand NAME

Allows to build predicates testing for certain beat name values.

DESCRIPTION

public static final StringOperand DESCRIPTION

Allows to build predicates testing for certain description values.

CREATION_TIME

public static final DateOperand CREATION_TIME

Allows to build predicates testing for certain beat creation time values.

UPDATE_TIME

public static final DateOperand UPDATE_TIME

Allows to build predicates testing for certain beat update time values.

GLOBAL_ORDER_INDEX

public static final BasicOperand<Long> GLOBAL_ORDER_INDEX

Allows to build predicates testing for certain beat global order index values.

EVENT_TYPE

public static final BasicOperand<EventType> EVENT_TYPE

Allows to build predicates testing for certain beat event type values.

EVENT_SUB_TYPE

public static final BasicOperand<EventType> EVENT_SUB_TYPE

Allows to build predicates testing for certain beat event sub type values.

ROOT_ID

public static final BasicOperand<BeatId> ROOT_ID

Allows to build predicates testing for certain beat root beat id values.

PARENT_ID

public static final BasicOperand<BeatId> PARENT_ID

Allows to build predicates testing for certain beat parent beat id values.

SOURCE_ID

public static final BasicOperand<EntityId> SOURCE_ID

Allows to build predicates testing for certain beat source id values.

SOURCE_FIELD_ID

public static final BasicOperand<FieldId> SOURCE_FIELD_ID

Allows to build predicates testing for certain beat source field id values.

Method Detail

getGlobalOrderIndex

public long getGlobalOrderIndex()

The order index across all Beats.

Returns:

the global order index

getEventType

public EventType getEventType()

The event type.

Returns:

the event type

getEventSubType

public EventType getEventSubType()

The event sub type.

Returns:

the event sub type

getRootId

public BeatId getRootId()

The root id of the beat.

Returns:

the id of the beat's root

getParentId

public BeatId getParentId()

The parent id of the beat.

Returns:

the id of the beat's parent

getSourceId

public EntityId getSourceId()

The source id.

Returns:

the source id

getSourceFieldId

public FieldId getSourceFieldId()

The source field id.

Returns:

the source field id

getSourceOldValue

public Object getSourceOldValue()

The former value of the source.

Returns:

the former value of the source

getSourceNewValue

public Object getSourceNewValue()

The new value of the source.

Returns:

the new value of the source

getSourceOldValueString

public String getSourceOldValueString()

The former value of the source represented as a string.

Returns:

the former value of the source as a string

getSourceNewValueString

public String getSourceNewValueString()

The new value of the source represented as a string.

Returns:

the new value of the source as a string

getSourceOldUpdateTime

public Date getSourceOldUpdateTime()

The former update time of the source.

Returns:

the former update time of the source

getSourceOldModificationVersion

public long getSourceOldModificationVersion()

The former modification version of the source.

Returns:

the former modification version of the source

getSourceOldModificationUpdaterId

public UserId getSourceOldModificationUpdaterId()

The former modifier of the source.

Returns:

the former modifier of the source

toString

public String toString()

Specified by:

toString in class Entity<BeatId,BeatProviderId>

builder

public static Beat.Builder builder()

Creates a builder for a new beat instance.

Returns:

the builder

builder

public static Beat.Builder builder(BeatId id)

Creates a builder for a new beat instance and applies the given id.

Parameters:

id - the id of the beat

Returns:

the builder

builder

public static Beat.Builder builder(Beat template)

Creates a builder for a new beat instance and applies the given template.

Parameters:

template - the beat template

Returns:

the builder