com.haulmont.cuba.core.app

Interface EntitySnapshotService

All Known Implementing Classes:

EntitySnapshotServiceBean

public interface EntitySnapshotService

Provides entity snapshots functionality.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
EntitySnapshot	createSnapshot(Entity entity, View view) Create snapshot for entity and save it to database
EntitySnapshot	createSnapshot(Entity entity, View view, java.util.Date snapshotDate) Create snapshot for Entity with specific date and store it to database
EntitySnapshot	createSnapshot(Entity entity, View view, java.util.Date snapshotDate, User author) Create snapshot for Entity with specific date and author and store it to database
Entity	extractEntity(EntitySnapshot snapshot) Get entity from snapshot
EntityDiff	getDifference(EntitySnapshot first, EntitySnapshot second) Get Diff for snapshots
java.util.List<EntitySnapshot>	getSnapshots(MetaClass metaClass, java.lang.Object id) Get snapshots for entity by id
void	migrateSnapshots(MetaClass metaClass, java.lang.Object id, java.util.Map<java.lang.Class,java.lang.Class> classMapping) Translate snapshots for archival classes

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getSnapshots

java.util.List<EntitySnapshot> getSnapshots(MetaClass metaClass,
                                            java.lang.Object id)

Get snapshots for entity by id

Parameters:

metaClass - Entity meta class

id - Entity id

Returns:

Snapshot list

createSnapshot

EntitySnapshot createSnapshot(Entity entity,
                              View view)

Create snapshot for entity and save it to database

Parameters:

entity - Entity

view - View

Returns:

Snapshot

createSnapshot

EntitySnapshot createSnapshot(Entity entity,
                              View view,
                              java.util.Date snapshotDate)

Create snapshot for Entity with specific date and store it to database

Parameters:

entity - Entity

view - View

snapshotDate - Date

Returns:

Snapshot

createSnapshot

EntitySnapshot createSnapshot(Entity entity,
                              View view,
                              java.util.Date snapshotDate,
                              User author)

Create snapshot for Entity with specific date and author and store it to database

Parameters:

entity - Entity

view - View

snapshotDate - Date

author - Author

Returns:

Snapshot

extractEntity

Entity extractEntity(EntitySnapshot snapshot)

Get entity from snapshot

Parameters:

snapshot - Snapshot

Returns:

Entity

getDifference

EntityDiff getDifference(@Nullable
                         EntitySnapshot first,
                         EntitySnapshot second)

Get Diff for snapshots

Parameters:

first - First snapshot

second - Second snapshot

Returns:

Diff

migrateSnapshots

void migrateSnapshots(MetaClass metaClass,
                      java.lang.Object id,
                      java.util.Map<java.lang.Class,java.lang.Class> classMapping)

Translate snapshots for archival classes

Parameters:

metaClass - Metaclass

id - Entity Id

classMapping - Map of [OldClass -> NewClass] for migration