com.activeviam.signoff.core.audit.impl

Class AAuditableJPA

java.lang.Object

com.activeviam.signoff.core.audit.impl.AAuditableJPA

All Implemented Interfaces:

IAuditable, Serializable

Direct Known Subclasses:

AAdjustmentJPA, ExportAuditJPA, ExportFileAuditJPA, MandateJPA, MandateParentChildJPA, MandateStatusJPA, StoreAdjustmentSubmissionJPA

@Entity
public abstract class AAuditableJPA
extends Object
implements IAuditable, Serializable

Abstract class to handle auditable objects

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	creator
protected String	id
protected String	liveFrom
protected String	liveTo
protected String	updater
protected long	utcTimestamp

Fields inherited from interface com.activeviam.signoff.core.audit.IAuditable

DEFAULT_LIVE_TO

Constructor Summary

Constructors

Constructor and Description
AAuditableJPA()

Method Summary

Modifier and Type	Method and Description
void	close(Instant now, String user) Method that closes an entry
boolean	equals(Object o)
String	getCreator() Get the creator of the record
String	getId() The unique id of the auditable object
String	getLiveFrom() Get the string representation of the live from date of the adjustment.
String	getLiveTo() Get the string representation of the live to date of the adjustment.
String	getUpdater() Get the updater of the record
long	getUtcTimestamp() Get the UTC timestamp of the record in milliseconds
int	hashCode()
boolean	isOpen() Check whether an entry is open or closed
void	open(Instant now, String user) Method that creates a new entry
void	setAsNew() Method used specifically for updates; for instance you can set the id of the entry to 'null' so that a new id is generated when the update entry is created.
void	setCreator(String creator) Set the creator of the record
void	setId(String id) Set the unique id of the auditable object
void	setLiveFrom(String liveFrom) Set the string representation of the live from date of the adjustment.
void	setLiveTo(String liveTo) Set the string representation of the live to date of the adjustment.
void	setUpdater(String updater) Set the creator of the record
void	setUtcTimestamp(long utcTimestamp) Set the UTC timestamp of the record in milliseconds

Methods inherited from class java.lang.Object

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

Field Detail

id

protected String id

liveFrom

protected String liveFrom

liveTo

protected String liveTo

creator

protected String creator

updater

protected String updater

utcTimestamp

protected long utcTimestamp

Constructor Detail

AAuditableJPA

public AAuditableJPA()

Method Detail

getId

public String getId()

Description copied from interface: IAuditable

The unique id of the auditable object

Specified by:

getId in interface IAuditable

Returns:

id

setId

public void setId(String id)

Description copied from interface: IAuditable

Set the unique id of the auditable object

Specified by:

setId in interface IAuditable

Parameters:

id - the id

getLiveFrom

public String getLiveFrom()

Description copied from interface: IAuditable

Get the string representation of the live from date of the adjustment.

Specified by:

getLiveFrom in interface IAuditable

Returns:

liveFrom

setLiveFrom

public void setLiveFrom(String liveFrom)

Description copied from interface: IAuditable

Set the string representation of the live from date of the adjustment.

Specified by:

setLiveFrom in interface IAuditable

Parameters:

liveFrom - the string representation of the live from date

getLiveTo

public String getLiveTo()

Description copied from interface: IAuditable

Get the string representation of the live to date of the adjustment.

Specified by:

getLiveTo in interface IAuditable

Returns:

liveTo

setLiveTo

public void setLiveTo(String liveTo)

Description copied from interface: IAuditable

Set the string representation of the live to date of the adjustment.

Specified by:

setLiveTo in interface IAuditable

Parameters:

liveTo - the string representation of the live to date

getCreator

public String getCreator()

Description copied from interface: IAuditable

Get the creator of the record

Specified by:

getCreator in interface IAuditable

Returns:

creator

setCreator

public void setCreator(String creator)

Description copied from interface: IAuditable

Set the creator of the record

Specified by:

setCreator in interface IAuditable

Parameters:

creator - the creator

getUpdater

public String getUpdater()

Description copied from interface: IAuditable

Get the updater of the record

Specified by:

getUpdater in interface IAuditable

Returns:

updater

setUpdater

public void setUpdater(String updater)

Description copied from interface: IAuditable

Set the creator of the record

Specified by:

setUpdater in interface IAuditable

Parameters:

updater - the updater

getUtcTimestamp

public long getUtcTimestamp()

Description copied from interface: IAuditable

Get the UTC timestamp of the record in milliseconds

Specified by:

getUtcTimestamp in interface IAuditable

Returns:

UTC timestamp in milliseconds

setUtcTimestamp

public void setUtcTimestamp(long utcTimestamp)

Description copied from interface: IAuditable

Set the UTC timestamp of the record in milliseconds

Specified by:

setUtcTimestamp in interface IAuditable

Parameters:

utcTimestamp - the UTC timestamp in milliseconds

open

public void open(Instant now,
                 String user)

Description copied from interface: IAuditable

Method that creates a new entry

Specified by:

open in interface IAuditable

Parameters:

now - the UTC timestamp in milliseconds of the current instant

user - the user id

setAsNew

public void setAsNew()

Description copied from interface: IAuditable

Method used specifically for updates; for instance you can set the id of the entry to 'null' so that a new id is generated when the update entry is created.

Specified by:

setAsNew in interface IAuditable

close

public void close(Instant now,
                  String user)

Description copied from interface: IAuditable

Method that closes an entry

Specified by:

close in interface IAuditable

Parameters:

now - the UTC timestamp in milliseconds of the current instant

user - the user

isOpen

public boolean isOpen()

Description copied from interface: IAuditable

Check whether an entry is open or closed

Specified by:

isOpen in interface IAuditable

Returns:

boolean

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object