com.broadleafcommerce.enterprise.audit.domain

Interface AuditHeader

All Superinterfaces:

Serializable

All Known Implementing Classes:

AuditHeaderImpl

public interface AuditHeader
extends Serializable

General information about the entity receiving the change

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method and Description
Date	getEventTime() The moment in time the change took place.
List<AuditHeaderAttribute>	getHeaderAttributes() Arbitrary additional values to associate with the header
Long	getId() AuditHeader primary key
String	getItemId() The primary key value of the entity receiving the change
List<AuditItem>	getItems() List of specific properties that were changed
String	getItemShortType() The simple classname of the entity receiving the change.
String	getItemTable() The RDBMS table name backing the entity receiving the change.
String	getItemType() The fully qualified classname of the entity receiving the change.
String	getMasqueradedUserDescription() The user description of the special user that is impersonating another user.
Long	getMasqueradedUserId() The primary key for the special user that is impersonating another user.
String	getMasqueradedUserType() The user type of the special user that is impersonating another user.
String	getNodeIpAddress() The ip address of the node that is persisting the change.
String	getNodeType() The type of node that is persisting this change.
String	getOperationType() The type of change.
String	getUserDescription() Descriptive information about the user.
Long	getUserId() The primary key value belonging to the user that caused the change
String	getUserIpAddress() The best guess for the ip address belonging to the user that caused the change.
String	getUserType() The type of user that caused the change.
void	setEventTime(Date eventTime)
void	setHeaderAttributes(List<AuditHeaderAttribute> attributes)
void	setId(Long id)
void	setItemId(String itemId)
void	setItems(List<AuditItem> items)
void	setItemShortType(String itemShortType)
void	setItemTable(String itemTable)
void	setItemType(String itemType)
void	setMasqueradedUserDescription(String masqueradedUserDescription)
void	setMasqueradedUserId(Long masqueradedUserId)
void	setMasqueradedUserType(String masqueradedUserType)
void	setNodeIpAddress(String nodeIpAddress)
void	setNodeType(String nodeType)
void	setOperationType(String operationType)
void	setUserDescription(String userDescription)
void	setUserId(Long userId)
void	setUserIpAddress(String userIpAddress)
void	setUserType(String userType)

Method Detail

getId

Long getId()

AuditHeader primary key

Returns:

setId

void setId(Long id)

getUserId

Long getUserId()

The primary key value belonging to the user that caused the change

Returns:

setUserId

void setUserId(Long userId)

getUserDescription

String getUserDescription()

Descriptive information about the user. This is usually email address.

Returns:

setUserDescription

void setUserDescription(String userDescription)

getUserType

String getUserType()

The type of user that caused the change. See AuditUserType

Returns:

setUserType

void setUserType(String userType)

getUserIpAddress

String getUserIpAddress()

The best guess for the ip address belonging to the user that caused the change. This is harvested from the HTTP request.

Returns:

setUserIpAddress

void setUserIpAddress(String userIpAddress)

getNodeType

String getNodeType()

The type of node that is persisting this change. This correlates to EventWorkerType

Returns:

setNodeType

void setNodeType(String nodeType)

getNodeIpAddress

String getNodeIpAddress()

The ip address of the node that is persisting the change.

Returns:

setNodeIpAddress

void setNodeIpAddress(String nodeIpAddress)

getEventTime

Date getEventTime()

The moment in time the change took place. This is the server time of the node performing the change.

Returns:

setEventTime

void setEventTime(Date eventTime)

getItemType

String getItemType()

The fully qualified classname of the entity receiving the change.

Returns:

setItemType

void setItemType(String itemType)

getItemShortType

String getItemShortType()

The simple classname of the entity receiving the change.

Returns:

setItemShortType

void setItemShortType(String itemShortType)

getItemTable

String getItemTable()

The RDBMS table name backing the entity receiving the change.

Returns:

setItemTable

void setItemTable(String itemTable)

getItemId

String getItemId()

The primary key value of the entity receiving the change

Returns:

setItemId

void setItemId(String itemId)

getHeaderAttributes

List<AuditHeaderAttribute> getHeaderAttributes()

Arbitrary additional values to associate with the header

Returns:

setHeaderAttributes

void setHeaderAttributes(List<AuditHeaderAttribute> attributes)

getItems

List<AuditItem> getItems()

List of specific properties that were changed

Returns:

setItems

void setItems(List<AuditItem> items)

getOperationType

String getOperationType()

The type of change. See OperationType

Returns:

setOperationType

void setOperationType(String operationType)

getMasqueradedUserId

Long getMasqueradedUserId()

The primary key for the special user that is impersonating another user. If applicable, this is the true source of the change. This is generally a CSR user that is acting on behalf of a regular user.

Returns:

setMasqueradedUserId

void setMasqueradedUserId(Long masqueradedUserId)

getMasqueradedUserDescription

String getMasqueradedUserDescription()

The user description of the special user that is impersonating another user. This is generally the email address. See getMasqueradedUserId().

Returns:

setMasqueradedUserDescription

void setMasqueradedUserDescription(String masqueradedUserDescription)

getMasqueradedUserType

String getMasqueradedUserType()

The user type of the special user that is impersonating another user. See AuditUserType. See getMasqueradedUserId().

Returns:

setMasqueradedUserType

void setMasqueradedUserType(String masqueradedUserType)