RevisionedEntity (JavaDocs for devon4j-basic 2020.12.002)

Type Parameters:

ID - is the type of the primary key.

All Superinterfaces:

GenericEntity<ID>, Serializable

All Known Subinterfaces:

RevisionedPersistenceEntity<ID>

All Known Implementing Classes:

RevisionedEto
```
public interface RevisionedEntity<ID>
extends GenericEntity<ID>
```
This is the interface for a GenericEntity that is (potentially) revision-controlled. Frameworks like hibernate-envers (look for @Audited annotation on JPA entities) or bi-temporal can manage such entities so all changes are stored in the database as a revision history. An instance of this interface represents the revision of the entity. There are two cases to distinguish:
- latest revision
  A RevisionedEntity pointing to LATEST_REVISION (null) represents the latest state of the entity and can be modified.
- historic revision
  If the object is revision controlled, it has a history of modifications. A RevisionedEntity can represent a historic revision out of this history. It therefore is immutable so operations to modify the RevisionedEntity will typically fail.
Since:

3.0.0

Field Summary

Fields
Modifier and Type Field Description

static Number LATEST_REVISION
The latest revision of an entity.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Number`	`getRevision()`	This method gets the revision of this entity.
`void`	`setRevision(Number revision)`	This method sets the `revision` of this entity.

Methods inherited from interface com.devonfw.module.basic.common.api.entity.GenericEntity
getId, getModificationCounter, setId, setModificationCounter

- Field Detail
  - LATEST_REVISION
```
static final Number LATEST_REVISION
```
    The latest revision of an entity.
- Method Detail
  - getRevision
```
Number getRevision()
```
    This method gets the revision of this entity. The latest revision of an entity will always return null. Otherwise this object is a historic entity and it will be read-only so modifications are NOT permitted.
    
    Returns:
    
    the revision or LATEST_REVISION (null) if this is the latest revision.
  - setRevision
```
void setRevision(Number revision)
```
    This method sets the revision of this entity.
    ATTENTION:
    This operation should only be used in specific cases and if you are aware of what you are doing as this attribute is managed by the persistence. However, for final freedom we decided to add this method to the API (e.g. to copy from transfer-object to persistent-entity and vice-versa).
    
    Parameters:
    
    revision - is the new value of getRevision().