com.helger.photon.basic.audit

Class AuditItem

java.lang.Object

com.helger.photon.basic.audit.AuditItem

All Implemented Interfaces:

com.helger.commons.state.ISuccessIndicator, IAuditItem, Serializable

@Immutable
public final class AuditItem
extends Object
implements IAuditItem

Represents a single change item

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuditItem(String sUserID, EAuditActionType eType, com.helger.commons.state.ESuccess eSuccess, String sAction)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAction()
LocalDateTime	getDateTime()
com.helger.commons.state.ESuccess	getSuccess()
EAuditActionType	getType()
String	getUserID()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.photon.basic.audit.IAuditItem

getTypeID, isAnonymousUser, isSuccess

Methods inherited from interface com.helger.commons.state.ISuccessIndicator

and, isFailure, or

Constructor Detail

AuditItem

public AuditItem(@Nullable
                 String sUserID,
                 @Nonnull
                 EAuditActionType eType,
                 @Nonnull
                 com.helger.commons.state.ESuccess eSuccess,
                 @Nonnull
                 String sAction)

Method Detail

getDateTime

@Nonnull
public LocalDateTime getDateTime()

Specified by:

getDateTime in interface IAuditItem

Returns:

The date and time when the audit item was created

getUserID

@Nonnull
public String getUserID()

Specified by:

getUserID in interface IAuditItem

Returns:

The ID of the user who triggered the action that resulted in this audit item.

getType

@Nonnull
public EAuditActionType getType()

Specified by:

getType in interface IAuditItem

Returns:

The audit action type. Never null.

getSuccess

@Nonnull
public com.helger.commons.state.ESuccess getSuccess()

Specified by:

getSuccess in interface IAuditItem

Returns:

Success or error?

getAction

@Nonnull
public String getAction()

Specified by:

getAction in interface IAuditItem

Returns:

The performed action in a textual representation like "action(param1,param2,...)"

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object