org.nuxeo.ecm.platform.audit.api
Interface LogEntry

All Superinterfaces:

Serializable

All Known Implementing Classes:

LogEntryBase, LogEntryImpl

public interface LogEntry
extends Serializable

Log entry interface.

Author:

Julien Anguenot

Method Summary

String	getCategory() Returns the category for this log entry.
String	getComment() Returns the associated comment for this log entry.
String	getDocLifeCycle() Return the life cycle if the document related to the log entry.
String	getDocPath() Returns the doc path related to the log entry.
String	getDocType() Returns the doc type related to the log entry.
String	getDocUUID() Returns the doc UUID related to the log entry.
Date	getEventDate() Returns the date of the event that originated the log entry.
String	getEventId() Returns the identifier of the event that originated the log entry.
long	getId() Returns the log identifier.
String	getPrincipalName() Returns the name of the principal who originated the log entry.

Method Detail

getId

long getId()

Returns the log identifier.

Returns:

the log identifier

getPrincipalName

String getPrincipalName()

Returns the name of the principal who originated the log entry.

Returns:

the name of the principal who originated the log entry

getEventId

String getEventId()

Returns the identifier of the event that originated the log entry.

Returns:

the identifier of the event that originated the log entry

getEventDate

Date getEventDate()

Returns the date of the event that originated the log entry.

Returns:

the date of the event that originated the log entry

getCategory

String getCategory()

Returns the category for this log entry.

This is defined at client level. Categories are not restricted in any ways.

Returns:

the category for this log entry.

getComment

String getComment()

Returns the associated comment for this log entry.

Returns:

the associated comment for this log entry

getDocUUID

String getDocUUID()

Returns the doc UUID related to the log entry.

It might be null if the event that originated the event is noe bound to any document.

Returns:

the doc UUID related to the log entry.

getDocPath

String getDocPath()

Returns the doc path related to the log entry.

It might be null if the event that originated the event is noe bound to any document.

Returns:

the doc path related to the log entry.

getDocType

String getDocType()

Returns the doc type related to the log entry.

It might be null if the event that originated the event is not bound to any document.

Returns:

the doc type related to the log entry.

getDocLifeCycle

String getDocLifeCycle()

Return the life cycle if the document related to the log entry.

It might be null if the event that originated the event is noe bound to any document.

Returns:

the life cycle if the document related to the log entry.