com.helger.photon.basic.audit

Interface IAuditItem

All Superinterfaces:

com.helger.commons.state.ISuccessIndicator, Serializable

All Known Implementing Classes:

AuditItem

@MustImplementEqualsAndHashcode
public interface IAuditItem
extends com.helger.commons.state.ISuccessIndicator, Serializable

Base interface for a single audit item

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
String	getAction()
LocalDateTime	getDateTime()
com.helger.commons.state.ESuccess	getSuccess()
EAuditActionType	getType()
default String	getTypeID()
String	getUserID()
default boolean	isAnonymousUser()
default boolean	isSuccess()

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

and, isFailure, or

Method Detail

getDateTime

@Nonnull
LocalDateTime getDateTime()

Returns:

The date and time when the audit item was created

getUserID

@Nonnull
String getUserID()

Returns:

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

isAnonymousUser

default boolean isAnonymousUser()

Returns:

true if the user ID equals CBasicSecurity.USER_ID_NONE_LOGGED_IN

getType

@Nonnull
EAuditActionType getType()

Returns:

The audit action type. Never null.

getTypeID

@Nonnull
 @Nonempty
default String getTypeID()

Returns:

The ID of the audit action type. Never null.

getSuccess

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

Returns:

Success or error?

isSuccess

default boolean isSuccess()

Specified by:

isSuccess in interface com.helger.commons.state.ISuccessIndicator

getAction

@Nonnull
String getAction()

Returns:

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