org.opencms.db.log
Enum CmsLogEntryType

java.lang.Object
  java.lang.Enum<CmsLogEntryType>
      org.opencms.db.log.CmsLogEntryType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CmsLogEntryType>

public enum CmsLogEntryType
extends java.lang.Enum<CmsLogEntryType>

Wrapper class for the different types of log entries.

The IDs are organized as following:

1-3

user actions (login successful, login failed, resource visited)

11-13

publish actions (modified, new, deleted)

15

publish list (hide)

21-24

resource additional information (relations, permissions, properties)

30

content changes

31-35

resource attributes (date expired, released, last modified; type, flags)

40-45

structure operations (create, copy, delete, move, import)

50-54

resource recovery (history, restore, undelete, undo changes)

Since:

8.0.0

Enum Constant Summary

RESOURCE_ADD_RELATION
Resource add relation entry.

RESOURCE_CHANGES_UNDONE
Undo changes entry.

RESOURCE_CLONED
Resource cloned entry.

RESOURCE_CONTENT_MODIFIED
Resource content modified entry.

RESOURCE_COPIED
Resource copied entry.

RESOURCE_CREATED
Resource created entry.

RESOURCE_DATE_EXPIRED
Resource set date expired entry.

RESOURCE_DATE_RELEASED
Resource set date released entry.

RESOURCE_DELETED
Resource deleted entry.

RESOURCE_FLAGS
Resource set flags entry.

RESOURCE_HIDDEN
Resource hidden from publish list entry.

RESOURCE_HISTORY
Resource restored from history entry.

RESOURCE_IMPORTED
Resource imported entry.

RESOURCE_MOVE_RESTORED
Resource undo changes with mov entry.

RESOURCE_MOVED
Resource moved entry.

RESOURCE_PERMISSIONS
Resource set permissions entry.

RESOURCE_PROPERTIES
Resource set properties entry.

RESOURCE_PUBLISHED_DELETED
Resource published deleted entry.

RESOURCE_PUBLISHED_MODIFIED
Resource published modified entry.

RESOURCE_PUBLISHED_NEW
Resource published new entry.

RESOURCE_REMOVE_RELATION
Resource remove relation entry.

RESOURCE_RESTORE_DELETED
Resource restore deleted entry.

RESOURCE_RESTORED
Resource undo changes without move entry.

RESOURCE_TOUCHED
Resource set date last modified entry.

RESOURCE_TYPE
Resource set type entry.

RESOURCE_UNDELETED
Resource undeleted entry.

Method Summary

java.lang.String	getDetailKey() Localization key for detail formatting.
int	getId() Returns the internal representation of this type.
java.lang.String	getLocalizedName(CmsMessages messages) Returns a localized name for the given log entry type.
java.lang.String	getLocalizedName(java.util.Locale locale) Returns a localized name for the given log entry type.
boolean	isActive() Checks if this log entry type is active or not.
boolean	isToPubList() Check if this type generates an entry in the user's publish list.
static CmsLogEntryType	valueOf(int id) Parses an int into a log entry type.
static CmsLogEntryType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CmsLogEntryType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RESOURCE_ADD_RELATION

public static final CmsLogEntryType RESOURCE_ADD_RELATION

Resource add relation entry.

RESOURCE_CLONED

public static final CmsLogEntryType RESOURCE_CLONED

Resource cloned entry.

RESOURCE_CONTENT_MODIFIED

public static final CmsLogEntryType RESOURCE_CONTENT_MODIFIED

Resource content modified entry.

RESOURCE_COPIED

public static final CmsLogEntryType RESOURCE_COPIED

Resource copied entry.

RESOURCE_CREATED

public static final CmsLogEntryType RESOURCE_CREATED

Resource created entry.

RESOURCE_DATE_EXPIRED

public static final CmsLogEntryType RESOURCE_DATE_EXPIRED

Resource set date expired entry.

RESOURCE_DATE_RELEASED

public static final CmsLogEntryType RESOURCE_DATE_RELEASED

Resource set date released entry.

RESOURCE_DELETED

public static final CmsLogEntryType RESOURCE_DELETED

Resource deleted entry.

RESOURCE_FLAGS

public static final CmsLogEntryType RESOURCE_FLAGS

Resource set flags entry.

RESOURCE_HIDDEN

public static final CmsLogEntryType RESOURCE_HIDDEN

Resource hidden from publish list entry.

RESOURCE_HISTORY

public static final CmsLogEntryType RESOURCE_HISTORY

Resource restored from history entry.

RESOURCE_IMPORTED

public static final CmsLogEntryType RESOURCE_IMPORTED

Resource imported entry.

RESOURCE_MOVE_RESTORED

public static final CmsLogEntryType RESOURCE_MOVE_RESTORED

Resource undo changes with mov entry.

RESOURCE_MOVED

public static final CmsLogEntryType RESOURCE_MOVED

Resource moved entry.

RESOURCE_PERMISSIONS

public static final CmsLogEntryType RESOURCE_PERMISSIONS

Resource set permissions entry.

RESOURCE_PROPERTIES

public static final CmsLogEntryType RESOURCE_PROPERTIES

Resource set properties entry.

RESOURCE_PUBLISHED_DELETED

public static final CmsLogEntryType RESOURCE_PUBLISHED_DELETED

Resource published deleted entry.

RESOURCE_PUBLISHED_MODIFIED

public static final CmsLogEntryType RESOURCE_PUBLISHED_MODIFIED

Resource published modified entry.

RESOURCE_PUBLISHED_NEW

public static final CmsLogEntryType RESOURCE_PUBLISHED_NEW

Resource published new entry.

RESOURCE_CHANGES_UNDONE

public static final CmsLogEntryType RESOURCE_CHANGES_UNDONE

Undo changes entry.

RESOURCE_REMOVE_RELATION

public static final CmsLogEntryType RESOURCE_REMOVE_RELATION

Resource remove relation entry.

RESOURCE_RESTORE_DELETED

public static final CmsLogEntryType RESOURCE_RESTORE_DELETED

Resource restore deleted entry.

RESOURCE_RESTORED

public static final CmsLogEntryType RESOURCE_RESTORED

Resource undo changes without move entry.

RESOURCE_TOUCHED

public static final CmsLogEntryType RESOURCE_TOUCHED

Resource set date last modified entry.

RESOURCE_TYPE

public static final CmsLogEntryType RESOURCE_TYPE

Resource set type entry.

RESOURCE_UNDELETED

public static final CmsLogEntryType RESOURCE_UNDELETED

Resource undeleted entry.

Method Detail

values

public static CmsLogEntryType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CmsLogEntryType c : CmsLogEntryType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CmsLogEntryType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

valueOf

public static CmsLogEntryType valueOf(int id)
                               throws CmsIllegalArgumentException

Parses an int into a log entry type.

Parameters:

id - the internal representation number to parse

Returns:

the enumeration element

Throws:

CmsIllegalArgumentException - if the given value could not be matched against a CmsLogEntryType object.

getDetailKey

public java.lang.String getDetailKey()

Localization key for detail formatting.

Returns:

localization key for detail formatting

getId

public int getId()

Returns the internal representation of this type.

Returns:

the internal representation of this type

getLocalizedName

public java.lang.String getLocalizedName(CmsMessages messages)

Returns a localized name for the given log entry type.

Parameters:

messages - the message bundle to use to resolve the name

Returns:

a localized name

getLocalizedName

public java.lang.String getLocalizedName(java.util.Locale locale)

Returns a localized name for the given log entry type.

Parameters:

locale - the locale

Returns:

a localized name

isActive

public boolean isActive()

Checks if this log entry type is active or not.

Returns:

true if this log entry type is active or not

isToPubList

public boolean isToPubList()

Check if this type generates an entry in the user's publish list.

Returns:

true if this type generates an entry in the user's publish list