Package com.znize.platform.entity.system

Interface SystemLog

All Superinterfaces:

java.lang.Cloneable, PersistenceEntity

public interface SystemLog
extends PersistenceEntity

System logging for create/edit/delete.

Since:

3.5

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PROPERTY_DESCRIPTION	Property name: description
static java.lang.String	PROPERTY_TIMESTAMP	Property name: timestamp

Fields inherited from interface com.znize.platform.entity.PersistenceEntity

ID_SEPARATOR, PROPERTY_ID, PROPERTY_INSTANCE, PROPERTY_SELECTED, PROPERTY_SEQUENCE_NO, PROPERTY_VERSION

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCommand()	Get the command name of the action.
java.lang.String	getDescription()	Get the description of the action.
EntityTypeId	getEntityTypeId()	Get the entity affected by the action
java.lang.String	getIpAddress()	Get the user ip address.
java.util.Date	getTimestamp()	Get the logging timestamp.
ActionDescriptor.Type	getType()	Get the type of the action such as create, delete, applyChange.
User	getUser()	Get the user who took the action to be logged
void	setCommand(java.lang.String command)	Set the command name of the action.
void	setDescription(java.lang.String description)	Set the description of the action.
void	setEntityTypeId(EntityTypeId entityTypeId)	Set the entity affected by the action
void	setIpAddress(java.lang.String ipAddress)	Set the user ip address.
void	setTimestamp(java.util.Date timestamp)	Set the logging timestamp.
void	setType(ActionDescriptor.Type type)	Set the type of the action such as create, delete, applyChange.
void	setUser(User user)	Set the user who took the action to be logged

Methods inherited from interface com.znize.platform.entity.PersistenceEntity

clone, getId, getInstance, getSequenceNo, getVersion, isChanged, isPartiallyInitialized, isPersisted, isSelected, isStatistics, setChanged, setId, setInstance, setPartiallyInitialized, setPersisted, setSelected, setSequenceNo, setStatistics, setVersion

Field Detail

PROPERTY_TIMESTAMP

static final java.lang.String PROPERTY_TIMESTAMP

Property name: timestamp

See Also:

Constant Field Values

PROPERTY_DESCRIPTION

static final java.lang.String PROPERTY_DESCRIPTION

Property name: description

Since:

5.20

See Also:

Constant Field Values

Method Detail

getUser

User getUser()

Get the user who took the action to be logged

Returns:

User instance

setUser

void setUser(User user)

Set the user who took the action to be logged

Parameters:

user - User instance

getTimestamp

java.util.Date getTimestamp()

Get the logging timestamp.

Returns:

a Date

setTimestamp

void setTimestamp(java.util.Date timestamp)

Set the logging timestamp.

Parameters:

timestamp - a Date

getIpAddress

java.lang.String getIpAddress()

Get the user ip address.

Returns:

ip address

setIpAddress

void setIpAddress(java.lang.String ipAddress)

Set the user ip address.

Parameters:

ipAddress - the ip address to set

getType

ActionDescriptor.Type getType()

Get the type of the action such as create, delete, applyChange.

Returns:

ActionDescriptor.Type instance

setType

void setType(ActionDescriptor.Type type)

Set the type of the action such as create, delete, applyChange.

Parameters:

type - action type

getCommand

java.lang.String getCommand()

Get the command name of the action.

Returns:

command name

setCommand

void setCommand(java.lang.String command)

Set the command name of the action.

Parameters:

command - command name

getEntityTypeId

EntityTypeId getEntityTypeId()

Get the entity affected by the action

Returns:

entity type and id

setEntityTypeId

void setEntityTypeId(EntityTypeId entityTypeId)

Set the entity affected by the action

Parameters:

entityTypeId - entity type and id

getDescription

java.lang.String getDescription()

Get the description of the action.

Returns:

description

setDescription

void setDescription(java.lang.String description)

Set the description of the action.

Parameters:

description - the description to set