org.odpi.openmetadata.frameworks.connectors.properties.beans

Class Comment

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

org.odpi.openmetadata.frameworks.connectors.properties.beans.Comment

All Implemented Interfaces:

Serializable

public class Comment
extends Referenceable

The Comment bean stores information about a comment connected to an asset. Comments provide informal feedback to assets and can be added at any time. Comments have the userId of the person who added the feedback, along with their comment text. The content of the comment is a personal statement (which is why the user's id is in the comment) and there is no formal review of the content.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	commentText
protected CommentType	commentType
protected boolean	isPublic
protected String	user

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

additionalProperties, confidenceGovernanceClassification, confidentialityGovernanceClassification, criticalityGovernanceClassification, latestChange, latestChangeDetails, meanings, qualifiedName, retentionGovernanceClassification, searchKeywords, securityTags

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

classifications, extendedProperties, guid, type, url

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Constructor and Description
Comment() Default constructor
Comment(Comment template) Copy/clone constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
String	getCommentText() Return the comment text.
CommentType	getCommentType() Return an enum that describes the type of comment.
boolean	getIsPublic() Return if this like is private ot the creating user.
String	getUser() Return the user id of the person who created the comment.
void	setCommentText(String commentText) Set up the comment text.
void	setCommentType(CommentType commentType) Set up the enum that describes the type of comment.
void	setIsPublic(boolean aPublic) Set up whether the like is private to the creating user or not.
void	setUser(String user) Set up the user id of the person who created the comment.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

getAdditionalProperties, getConfidenceGovernanceClassification, getConfidentialityGovernanceClassification, getCriticalityGovernanceClassification, getLatestChange, getLatestChangeDetails, getMeanings, getQualifiedName, getRetentionGovernanceClassification, getSearchKeywords, getSecurityTags, hashCode, setAdditionalProperties, setConfidenceGovernanceClassification, setConfidentialityGovernanceClassification, setCriticalityGovernanceClassification, setLatestChange, setLatestChangeDetails, setMeanings, setQualifiedName, setRetentionGovernanceClassification, setSearchKeywords, setSecurityTags

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

getClassifications, getExtendedProperties, getGUID, getType, getURL, setClassifications, setExtendedProperties, setGUID, setType, setURL

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

getHeaderVersion, setHeaderVersion

Methods inherited from class java.lang.Object

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

Field Detail

commentType

protected CommentType commentType

commentText

protected String commentText

user

protected String user

isPublic

protected boolean isPublic

Constructor Detail

Comment

public Comment()

Default constructor

Comment

public Comment(Comment template)

Copy/clone constructor.

Parameters:

template - element to copy

Method Detail

getCommentType

public CommentType getCommentType()

Return an enum that describes the type of comment.

Returns:

CommentType enum

setCommentType

public void setCommentType(CommentType commentType)

Set up the enum that describes the type of comment.

Parameters:

commentType - CommentType enum

getCommentText

public String getCommentText()

Return the comment text.

Returns:

String commentText

setCommentText

public void setCommentText(String commentText)

Set up the comment text.

Parameters:

commentText - String text

getUser

public String getUser()

Return the user id of the person who created the comment. Null means the user id is not known.

Returns:

String commenting user

setUser

public void setUser(String user)

Set up the user id of the person who created the comment. Null means the user id is not known.

Parameters:

user - String commenting user

getIsPublic

public boolean getIsPublic()

Return if this like is private ot the creating user.

Returns:

boolean

setIsPublic

public void setIsPublic(boolean aPublic)

Set up whether the like is private to the creating user or not.

Parameters:

aPublic - boolean

toString

public String toString()

Standard toString method.

Overrides:

toString in class Referenceable

Returns:

print out of variables in a JSON-style

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class Referenceable

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison