com.atlassian.audit.entity

Class AuditType

java.lang.Object

com.atlassian.audit.entity.AuditType

public class AuditType
extends Object

Represents the Audit Type information of the Audit event including Audit Area Audit Level Audit category Audit action

Audit event types are unique across applications.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuditType.Builder

Constructor Summary

Constructors

Constructor and Description
AuditType(CoverageArea area, String category, String action, CoverageLevel level) Deprecated. since 1.7.0 use AuditType(Builder) variant which expects i18n keys for category and action.

Method Summary

Modifier and Type	Method and Description
static AuditType.Builder	builder(AuditType auditType)
boolean	equals(Object o)
static AuditType.Builder	fromI18nKeys(CoverageArea area, CoverageLevel level, String categoryI18nKey, String actionI18nKey)
String	getAction()
String	getActionI18nKey()
CoverageArea	getArea()
String	getCategory()
String	getCategoryI18nKey()
CoverageLevel	getLevel()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditType

@Deprecated
public AuditType(@Nonnull
                             CoverageArea area,
                             @Nonnull
                             String category,
                             @Nonnull
                             String action,
                             @Nonnull
                             CoverageLevel level)

Deprecated. since 1.7.0 use AuditType(Builder) variant which expects i18n keys for category and action.

Audit Type

Method Detail

getArea

@Nonnull
public CoverageArea getArea()

getCategoryI18nKey

@Nonnull
public String getCategoryI18nKey()

Returns:

the i18n key of the category of the event, e.g. audit.product.category.projects

getCategory

@Nullable
public String getCategory()

Returns:

the category of the event translated, e.g. "Projects"

getActionI18nKey

@Nonnull
public String getActionI18nKey()

Returns:

the i18n key of the scenario of the event, e.g. audit.product.action.projects.create

getAction

@Nullable
public String getAction()

Returns:

the scenario of the event, e.g. "Create Project"

getLevel

@Nonnull
public CoverageLevel getLevel()

toString

public String toString()

Overrides:

toString in class Object

fromI18nKeys

public static AuditType.Builder fromI18nKeys(@Nonnull
                                             CoverageArea area,
                                             @Nonnull
                                             CoverageLevel level,
                                             @Nonnull
                                             String categoryI18nKey,
                                             @Nonnull
                                             String actionI18nKey)

builder

public static AuditType.Builder builder(@Nonnull
                                        AuditType auditType)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object