Package org.nuxeo.ecm.platform.comment.api

Class CommentImpl

java.lang.Object

org.nuxeo.ecm.platform.comment.api.CommentImpl

All Implemented Interfaces:

Comment, ExternalEntity

Direct Known Subclasses:

AnnotationImpl

public class CommentImpl
extends Object
implements Comment, ExternalEntity

Since:

10.3

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<String>	ancestorIds	Deprecated. since 11.1, not used due to docModel usage
protected String	author	Deprecated. since 11.1, not used due to docModel usage
protected Instant	creationDate	Deprecated. since 11.1, not used due to docModel usage
protected DocumentModel	docModel	DocumentModel storing the Comment metadata.
protected String	entity	Deprecated. since 11.1, not used due to docModel usage
protected String	entityId	Deprecated. since 11.1, not used due to docModel usage
protected String	id	Deprecated. since 11.1, not used due to docModel usage
protected Instant	modificationDate	Deprecated. since 11.1, not used due to docModel usage
protected String	origin	Deprecated. since 11.1, not used due to docModel usage
protected String	parentId	Deprecated. since 11.1, not used due to docModel usage
protected String	text	Deprecated. since 11.1, not used due to docModel usage

Constructor Summary

Constructors

Modifier	Constructor	Description
	CommentImpl()
protected	CommentImpl(DocumentModel docModel)	Constructor for the document adapter factory.

Method Summary

Modifier and Type	Method	Description
void	addAncestorId(String ancestorId)	Deprecated.
boolean	equals(Object o)
Collection<String>	getAncestorIds()	Gets the list of ancestor ids.
String	getAuthor()	Gets comment author.
Instant	getCreationDate()	Gets comment creation date.
DocumentModel	getDocument()	Gets the document model backing this pojo.
String	getEntity()	Gets annotation entity.
String	getEntityId()	Gets annotation entity id, generated by the external service.
String	getId()	Gets comment id.
Instant	getModificationDate()	Sets comment modification date.
String	getOrigin()	Gets annotation origin.
String	getParentId()	Gets parent id.
String	getText()	Gets comment text.
int	hashCode()
void	setAuthor(String author)	Sets comment author.
void	setCreationDate(Instant creationDate)	Sets comment creation date.
void	setEntity(String entity)	Sets annotation entity.
void	setEntityId(String entityId)	Sets annotation entity id.
void	setId(String id)	Deprecated.
void	setModificationDate(Instant modificationDate)	Sets comment modification date.
void	setOrigin(String origin)	Sets annotation origin.
void	setParentId(String parentId)	Sets parent id.
void	setText(String text)	Sets comment text.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

id

@Deprecated(since="11.1")
protected String id

Deprecated.

since 11.1, not used due to docModel usage

parentId

@Deprecated(since="11.1")
protected String parentId

Deprecated.

since 11.1, not used due to docModel usage

ancestorIds

@Deprecated(since="11.1")
protected Collection<String> ancestorIds

Deprecated.

since 11.1, not used due to docModel usage

author

@Deprecated(since="11.1")
protected String author

Deprecated.

since 11.1, not used due to docModel usage

text

@Deprecated(since="11.1")
protected String text

Deprecated.

since 11.1, not used due to docModel usage

creationDate

@Deprecated(since="11.1")
protected Instant creationDate

Deprecated.

since 11.1, not used due to docModel usage

modificationDate

@Deprecated(since="11.1")
protected Instant modificationDate

Deprecated.

since 11.1, not used due to docModel usage

entityId

@Deprecated(since="11.1")
protected String entityId

Deprecated.

since 11.1, not used due to docModel usage

origin

@Deprecated(since="11.1")
protected String origin

Deprecated.

since 11.1, not used due to docModel usage

entity

@Deprecated(since="11.1")
protected String entity

Deprecated.

since 11.1, not used due to docModel usage

docModel

protected DocumentModel docModel

DocumentModel storing the Comment metadata.

Since:

11.1

Constructor Detail

CommentImpl

public CommentImpl()

Since:

11.1

CommentImpl

protected CommentImpl(DocumentModel docModel)

Constructor for the document adapter factory.

Since:

11.1

Method Detail

getId

public String getId()

Description copied from interface: Comment

Gets comment id.

Specified by:

getId in interface Comment

Returns:

the id

setId

@Deprecated(since="11.1")
public void setId(String id)

Deprecated.

Description copied from interface: Comment

Sets comment id.

Specified by:

setId in interface Comment

Parameters:

id - the id

getParentId

public String getParentId()

Description copied from interface: Comment

Gets parent id.

Specified by:

getParentId in interface Comment

Returns:

the parent id

setParentId

public void setParentId(String parentId)

Description copied from interface: Comment

Sets parent id.

Specified by:

setParentId in interface Comment

Parameters:

parentId - the parent id

getAncestorIds

public Collection<String> getAncestorIds()

Description copied from interface: Comment

Gets the list of ancestor ids.

Specified by:

getAncestorIds in interface Comment

Returns:

the list of ancestor ids

addAncestorId

@Deprecated(since="11.1")
public void addAncestorId(String ancestorId)

Deprecated.

Description copied from interface: Comment

Adds an ancestor id.

Specified by:

addAncestorId in interface Comment

Parameters:

ancestorId - the ancestor id

getAuthor

public String getAuthor()

Description copied from interface: Comment

Gets comment author.

Specified by:

getAuthor in interface Comment

Returns:

the author

setAuthor

public void setAuthor(String author)

Description copied from interface: Comment

Sets comment author.

Specified by:

setAuthor in interface Comment

Parameters:

author - the author

getText

public String getText()

Description copied from interface: Comment

Gets comment text.

Specified by:

getText in interface Comment

Returns:

the text

setText

public void setText(String text)

Description copied from interface: Comment

Sets comment text.

Specified by:

setText in interface Comment

Parameters:

text - the text

getCreationDate

public Instant getCreationDate()

Description copied from interface: Comment

Gets comment creation date.

Specified by:

getCreationDate in interface Comment

Returns:

the creation date

setCreationDate

public void setCreationDate(Instant creationDate)

Description copied from interface: Comment

Sets comment creation date.

Specified by:

setCreationDate in interface Comment

Parameters:

creationDate - the creation date

getModificationDate

public Instant getModificationDate()

Description copied from interface: Comment

Sets comment modification date.

Specified by:

getModificationDate in interface Comment

Returns:

the modification date

setModificationDate

public void setModificationDate(Instant modificationDate)

Description copied from interface: Comment

Sets comment modification date.

Specified by:

setModificationDate in interface Comment

Parameters:

modificationDate - the modification date

getEntityId

public String getEntityId()

Description copied from interface: ExternalEntity

Gets annotation entity id, generated by the external service.

Specified by:

getEntityId in interface ExternalEntity

Returns:

the entity id

setEntityId

public void setEntityId(String entityId)

Description copied from interface: ExternalEntity

Sets annotation entity id.

Specified by:

setEntityId in interface ExternalEntity

Parameters:

entityId - the entity id

getOrigin

public String getOrigin()

Description copied from interface: ExternalEntity

Gets annotation origin.

Specified by:

getOrigin in interface ExternalEntity

Returns:

the origin

setOrigin

public void setOrigin(String origin)

Description copied from interface: ExternalEntity

Sets annotation origin.

Specified by:

setOrigin in interface ExternalEntity

Parameters:

origin - the origin

getEntity

public String getEntity()

Description copied from interface: ExternalEntity

Gets annotation entity. This represents the annotation model as the rendition server describes it.

Specified by:

getEntity in interface ExternalEntity

Returns:

the entity

setEntity

public void setEntity(String entity)

Description copied from interface: ExternalEntity

Sets annotation entity.

Specified by:

setEntity in interface ExternalEntity

Parameters:

entity - the entity

getDocument

public DocumentModel getDocument()

Description copied from interface: Comment

Gets the document model backing this pojo.

Specified by:

getDocument in interface Comment

Returns:

the document model backing this pojo

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object