org.odpi.openmetadata.accessservices.communityprofile.properties

Class Tag

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.properties.CommunityProfileElementHeader

org.odpi.openmetadata.accessservices.communityprofile.properties.CommonHeader

org.odpi.openmetadata.accessservices.communityprofile.properties.IdentifiableUserHeader

org.odpi.openmetadata.accessservices.communityprofile.properties.UserFeedbackHeader

org.odpi.openmetadata.accessservices.communityprofile.properties.Tag

All Implemented Interfaces:

Serializable

public class Tag
extends UserFeedbackHeader

Tag records a descriptive definition added to an element.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Tag() Default constructor
Tag(Tag template) Copy/clone constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Equals method that returns true if containing properties are the same.
String	getDescription() Return the description of the tag.
boolean	getIsPrivate() Return whether the tag is private or not.
String	getName() Return the name of the tag.
int	hashCode() Hash code for this object
void	setDescription(String description) Set up the description of the tag.
void	setIsPrivate(boolean privateTag) Set whether the tag is private or not.
void	setName(String name) Set up the name of the tag.
String	toString() JSON-style toString.

Methods inherited from class org.odpi.openmetadata.accessservices.communityprofile.properties.IdentifiableUserHeader

getUserId, setUserId

Methods inherited from class org.odpi.openmetadata.accessservices.communityprofile.properties.CommonHeader

getGUID, setGUID

Methods inherited from class org.odpi.openmetadata.accessservices.communityprofile.properties.CommunityProfileElementHeader

getOriginId, getOriginLicense, getOriginName, getOriginType, getTypeDescription, getTypeName, setOriginId, setOriginLicense, setOriginName, setOriginType, setTypeDescription, setTypeName

Methods inherited from class java.lang.Object

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

Constructor Detail

Tag

public Tag()

Default constructor

Tag

public Tag(Tag template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getName

public String getName()

Return the name of the tag. this is a descriptive name that describes the element that the tag is attached to.

Returns:

tag name

setName

public void setName(String name)

Set up the name of the tag. this is a descriptive name that describes the element that the tag is attached to.

Parameters:

name - tag name

getDescription

public String getDescription()

Return the description of the tag. This is optional.

Returns:

tag description

setDescription

public void setDescription(String description)

Set up the description of the tag. This is optional.

Parameters:

description - tag description

getIsPrivate

public boolean getIsPrivate()

Return whether the tag is private or not. Private tags are only returned to the user that created them.

Returns:

private tag indicator

setIsPrivate

public void setIsPrivate(boolean privateTag)

Set whether the tag is private or not. Private tags are only returned to the user that created them.

Parameters:

privateTag - private tag indicator

toString

public String toString()

JSON-style toString.

Overrides:

toString in class UserFeedbackHeader

Returns:

list of properties and their values.

equals

public boolean equals(Object objectToCompare)

Equals method that returns true if containing properties are the same.

Overrides:

equals in class UserFeedbackHeader

Parameters:

objectToCompare - object to compare

Returns:

boolean result of comparison

hashCode

public int hashCode()

Hash code for this object

Overrides:

hashCode in class UserFeedbackHeader

Returns:

int