org.odpi.openmetadata.accessservices.assetconsumer.properties

Class CommentProperties

java.lang.Object

org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableProperties

org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentProperties

All Implemented Interfaces:

Serializable

public class CommentProperties
extends ReferenceableProperties

The CommentProperties 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

Constructor Summary

Constructors

Constructor and Description
CommentProperties() Default constructor
CommentProperties(CommentProperties 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 whether the comment is private to the creating user or not.
String	getUser() Return the user id of the person who created the comment.
int	hashCode() Create a hash code for this element type.
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 isPublic) Set up whether the comment 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.accessservices.assetconsumer.properties.ReferenceableProperties

getAdditionalProperties, getExtendedProperties, getQualifiedName, getTypeName, setAdditionalProperties, setExtendedProperties, setQualifiedName, setTypeName

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentProperties

public CommentProperties()

Default constructor

CommentProperties

public CommentProperties(CommentProperties 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 whether the comment is private to the creating user or not.

Returns:

boolean

setIsPublic

public void setIsPublic(boolean isPublic)

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

Parameters:

isPublic - boolean

toString

public String toString()

Standard toString method.

Overrides:

toString in class ReferenceableProperties

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 ReferenceableProperties

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Create a hash code for this element type.

Overrides:

hashCode in class ReferenceableProperties

Returns:

int hash code