com.activeviam.signoff.core.audit

Interface IAuditable

All Known Subinterfaces:

IAdjustment, ICubeAdjustment, IExportAudit, IExportFileAudit, IMandate, IMandateParentChild, IMandateStatus, IStoreAdjustment, IStoreAdjustmentSubmission

All Known Implementing Classes:

AAdjustmentJPA, AAuditableJPA, CubeAdjustmentJPA, ExportAuditJPA, ExportFileAuditJPA, MandateJPA, MandateParentChildJPA, MandateStatusJPA, StoreAdjustmentJPA, StoreAdjustmentSubmissionJPA

public interface IAuditable

Interface to handle auditable objects

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LIVE_TO

Method Summary

Modifier and Type	Method and Description
void	close(Instant now, String user) Method that closes an entry
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
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

Field Detail

DEFAULT_LIVE_TO

static final String DEFAULT_LIVE_TO

See Also:

Constant Field Values

Method Detail

getId

String getId()

The unique id of the auditable object

Returns:

id

setId

void setId(String id)

Set the unique id of the auditable object

Parameters:

id - the id

getLiveFrom

String getLiveFrom()

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

Returns:

liveFrom

setLiveFrom

void setLiveFrom(String liveFrom)

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

Parameters:

liveFrom - the string representation of the live from date

getLiveTo

String getLiveTo()

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

Returns:

liveTo

setLiveTo

void setLiveTo(String liveTo)

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

Parameters:

liveTo - the string representation of the live to date

getCreator

String getCreator()

Get the creator of the record

Returns:

creator

setCreator

void setCreator(String creator)

Set the creator of the record

Parameters:

creator - the creator

getUpdater

String getUpdater()

Get the updater of the record

Returns:

updater

setUpdater

void setUpdater(String updater)

Set the creator of the record

Parameters:

updater - the updater

getUtcTimestamp

long getUtcTimestamp()

Get the UTC timestamp of the record in milliseconds

Returns:

UTC timestamp in milliseconds

setUtcTimestamp

void setUtcTimestamp(long utcTimestamp)

Set the UTC timestamp of the record in milliseconds

Parameters:

utcTimestamp - the UTC timestamp in milliseconds

open

void open(Instant now,
          String user)

Method that creates a new entry

Parameters:

now - the UTC timestamp in milliseconds of the current instant

user - the user id

setAsNew

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.

close

void close(Instant now,
           String user)

Method that closes an entry

Parameters:

now - the UTC timestamp in milliseconds of the current instant

user - the user

isOpen

boolean isOpen()

Check whether an entry is open or closed

Returns:

boolean