Package org.broadleafcommerce.common.audit

Class AuditableListener

java.lang.Object

org.broadleafcommerce.common.audit.AbstractAuditableListener

org.broadleafcommerce.common.audit.AuditableListener

public class AuditableListener
extends AbstractAuditableListener

Constructor Summary

Constructors

Constructor	Description
AuditableListener()

Method Summary

Modifier and Type	Method	Description
void	setAuditCreationAndUpdateData(Object entity)	Method that will be invoked in a registered listener to set the entity's creation data.
void	setAuditUpdateData(Object entity)	Method that will be invoked in a registered listener to set the entity's update data.
protected void	setAuditValueAgent(Field field, Object entity)	Method that sets the user-related data.

Methods inherited from class org.broadleafcommerce.common.audit.AbstractAuditableListener

getAuditableFieldName, setAuditCreationData, setAuditData, setAuditUpdateData, setAuditValueTemporal

Methods inherited from class java.lang.Object

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

Constructor Details

AuditableListener

public AuditableListener()

Method Details

setAuditCreationAndUpdateData

public void setAuditCreationAndUpdateData(Object entity)
                                   throws Exception

Description copied from class: AbstractAuditableListener

Method that will be invoked in a registered listener to set the entity's creation data. In most cases, calling AbstractAuditableListener.setAuditCreationData(Object, Object) should suffice.

Specified by:

setAuditCreationAndUpdateData in class AbstractAuditableListener

Throws:

Exception

setAuditUpdateData

public void setAuditUpdateData(Object entity)
                        throws Exception

Description copied from class: AbstractAuditableListener

Method that will be invoked in a registered listener to set the entity's update data. In most cases, calling AbstractAuditableListener.setAuditUpdateData(Object, Object) should suffice.

Specified by:

setAuditUpdateData in class AbstractAuditableListener

Throws:

Exception

setAuditValueAgent

protected void setAuditValueAgent(Field field,
 Object entity)
                           throws IllegalArgumentException,
IllegalAccessException

Description copied from class: AbstractAuditableListener

Method that sets the user-related data.

Specified by:

setAuditValueAgent in class AbstractAuditableListener

Throws:

IllegalArgumentException

IllegalAccessException