sirius.biz.protocol

Class JournalData

java.lang.Object

sirius.kernel.di.transformers.Composable

sirius.db.mixing.Mixable

sirius.db.mixing.Composite

sirius.biz.protocol.JournalData

All Implemented Interfaces:

sirius.kernel.di.transformers.Transformable

public class JournalData
extends sirius.db.mixing.Composite

Provides a hook which records all changed fields into the system journal which can be embedded into other entities or mixins.

To skip a field, a NoJournal annotation can be placed. To skip a record entirely, setSilent(boolean) can be called before the update or delete.

Field Summary

Fields inherited from class sirius.db.mixing.Mixable

elastic, mango, mixing, oma

Fields inherited from class sirius.kernel.di.transformers.Composable

components

Constructor Summary

Constructors

Constructor and Description
JournalData(sirius.db.mixing.BaseEntity<?> owner) Creates a new instance for the given entity.

Method Summary

Modifier and Type	Method and Description
static void	addJournalEntry(sirius.db.mixing.BaseEntity<?> entity, String changes) Adds an entry to the journal of the given entity.
String	getProtocolUri()
boolean	hasJournaledChanges() Determines if there are recordable changes in the referenced entity.
boolean	isSilent() Determines if the next change should be skipped (not recorded).
protected void	onDelete()
protected void	onSave()
void	setSilent(boolean silent) Sets the skip flag.

Methods inherited from class sirius.db.mixing.Mixable

is, makeNewInstance, tryAs

Methods inherited from class sirius.kernel.di.transformers.Composable

as, attach, attach

Methods inherited from class java.lang.Object

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

Constructor Detail

JournalData

public JournalData(sirius.db.mixing.BaseEntity<?> owner)

Creates a new instance for the given entity.

Parameters:

owner - the entity which fields are to be recorded.

Method Detail

onSave

protected void onSave()

addJournalEntry

public static void addJournalEntry(sirius.db.mixing.BaseEntity<?> entity,
                                   String changes)

Adds an entry to the journal of the given entity.

Parameters:

entity - the entity to write a journal entry for

changes - the entry to add to the journal

onDelete

protected void onDelete()

isSilent

public boolean isSilent()

Determines if the next change should be skipped (not recorded).

Returns:

true if the next change should be skipped, false otherwise

setSilent

public void setSilent(boolean silent)

Sets the skip flag.

Calling this with true, will skip all changes performed on the referenced entity instance.

Parameters:

silent - true to skip the recording of all changes on the referenced entity instance, false to re-enable.

hasJournaledChanges

public boolean hasJournaledChanges()

Determines if there are recordable changes in the referenced entity.

Returns:

true if at least one journaled field changed, false otherwise

getProtocolUri

public String getProtocolUri()