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

All Superinterfaces:

Serializable

All Known Implementing Classes:

LogEntryImpl

public interface LogEntry
extends Serializable

Log entry.

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.
Map<String,ExtendedInfo>	getExtendedInfos()
long	getId()
UIAuditComment	getPreprocessedComment() Return the comment preprocessed to be ready for display.
String	getPrincipalName() Returns the name of the principal who originated the log entry.
String	getRepositoryId() Returns the repository id related to the log entry.
void	setCategory(String category)
void	setComment(String comment)
void	setDocLifeCycle(String docLifeCycle)
void	setDocPath(String docPath)
void	setDocType(String docType)
void	setDocUUID(DocumentRef docRef)
void	setDocUUID(String docUUID)
void	setEventDate(Date eventDate)
void	setEventId(String eventId)
void	setExtendedInfos(Map<String,ExtendedInfo> infos)
void	setId(long id)
void	setPreprocessedComment(UIAuditComment uiComment)
void	setPrincipalName(String principalName)
void	setRepositoryId(String repositoryId)

Method Detail

getId

long getId()

Returns:

the log identifier

setId

void setId(long id)

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

setPrincipalName

void setPrincipalName(String principalName)

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

setEventId

void setEventId(String eventId)

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

setEventDate

void setEventDate(Date eventDate)

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.

setDocUUID

void setDocUUID(String docUUID)

setDocUUID

void setDocUUID(DocumentRef docRef)

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.

setDocPath

void setDocPath(String docPath)

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.

setDocType

void setDocType(String docType)

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.

setCategory

void setCategory(String category)

getComment

String getComment()

Returns the associated comment for this log entry.

Returns:

the associated comment for this log entry

setComment

void setComment(String comment)

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.

setDocLifeCycle

void setDocLifeCycle(String docLifeCycle)

getRepositoryId

String getRepositoryId()

Returns the repository id related to the log entry.

Returns:

the repository id

setRepositoryId

void setRepositoryId(String repositoryId)

getExtendedInfos

Map<String,ExtendedInfo> getExtendedInfos()

setExtendedInfos

void setExtendedInfos(Map<String,ExtendedInfo> infos)

getPreprocessedComment

UIAuditComment getPreprocessedComment()

Return the comment preprocessed to be ready for display. (extract info about linked documents) Only available when accessed via the entry is fetched via the AuditPageProvider

Returns:

setPreprocessedComment

void setPreprocessedComment(UIAuditComment uiComment)