org.synyx.hades.domain.auditing
Interface Auditable<U,PK extends java.io.Serializable>

Type Parameters:

U - the auditing type. Typically some kind of user.

PK - the type of the auditing type's idenifier

All Superinterfaces:

Persistable<PK>, java.io.Serializable

All Known Implementing Classes:

AbstractAuditable

public interface Auditable<U,PK extends java.io.Serializable>
extends Persistable<PK>

Interface for auditable entities. Allows storing and retrieving creation and modification information. The changing instance (typically some user) is to be defined by a generics definition.

Author:

Oliver Gierke - gierke@synyx.de

Method Summary

U	getCreatedBy() Returns the user who created this entity.
org.joda.time.DateTime	getCreatedDate() Returns the creation date of the entity.
U	getLastModifiedBy() Returns the user who modified the entity lastly.
org.joda.time.DateTime	getLastModifiedDate() Returns the date of the last modification.
void	setCreated(org.joda.time.DateTime creationDate) Sets the creation date of the entity.
void	setCreatedBy(U createdBy) Sets the user who created this entity.
void	setLastModified(org.joda.time.DateTime lastModifiedDate) Sets the date of the last modification.
void	setLastModifiedBy(U lastModifiedBy) Sets the user who modified the entity lastly.

Methods inherited from interface org.synyx.hades.domain.Persistable

getId, isNew

Method Detail

getCreatedBy

U getCreatedBy()

Returns the user who created this entity.

Returns:

the createdBy

setCreatedBy

void setCreatedBy(U createdBy)

Sets the user who created this entity.

Parameters:

createdBy - the creating entity to set

getCreatedDate

org.joda.time.DateTime getCreatedDate()

Returns the creation date of the entity.

Returns:

the createdDate

setCreated

void setCreated(org.joda.time.DateTime creationDate)

Sets the creation date of the entity.

Parameters:

creationDate - the creation date to set

getLastModifiedBy

U getLastModifiedBy()

Returns the user who modified the entity lastly.

Returns:

the lastModifiedBy

setLastModifiedBy

void setLastModifiedBy(U lastModifiedBy)

Sets the user who modified the entity lastly.

Parameters:

lastModifiedBy - the last modifying entity to set

getLastModifiedDate

org.joda.time.DateTime getLastModifiedDate()

Returns the date of the last modification.

Returns:

the lastModifiedDate

setLastModified

void setLastModified(org.joda.time.DateTime lastModifiedDate)

Sets the date of the last modification.

Parameters:

lastModifiedDate - the date of the last modification to set