org.odpi.openmetadata.commonservices.ocf.metadatamanagement.rest

Class TagRequestBody

java.lang.Object

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.rest.OCFOMASAPIRequestBody

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.rest.FeedbackRequestBody

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.rest.TagRequestBody

All Implemented Interfaces:

Serializable

public class TagRequestBody
extends FeedbackRequestBody

TagRequestBody provides a structure for passing an informal tag as a request body over a REST API.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TagRequestBody() Default constructor
TagRequestBody(TagRequestBody 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	getTagDescription() Return the description that accompanies the tag.
String	getTagName() Return the name of the tag.
int	hashCode() Return hash code for this object
void	setTagDescription(String tagDescription) Set up the description that accompanies the tag.
void	setTagName(String tagName) Set up the name of the tag.
String	toString() JSON-style toString.

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.rest.FeedbackRequestBody

isPublic, setPublic

Methods inherited from class java.lang.Object

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

Constructor Detail

TagRequestBody

public TagRequestBody()

Default constructor

TagRequestBody

public TagRequestBody(TagRequestBody template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getTagName

public String getTagName()

Return the name of the tag.

Returns:

string

setTagName

public void setTagName(String tagName)

Set up the name of the tag.

Parameters:

tagName - string

getTagDescription

public String getTagDescription()

Return the description that accompanies the tag.

Returns:

string description

setTagDescription

public void setTagDescription(String tagDescription)

Set up the description that accompanies the tag.

Parameters:

tagDescription - String (optional) description of the tag. Setting a description, particularly in a public tag makes the tag more valuable to other users and can act as an embryonic glossary term.

toString

public String toString()

JSON-style toString.

Overrides:

toString in class FeedbackRequestBody

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 FeedbackRequestBody

Parameters:

objectToCompare - object to compare

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class FeedbackRequestBody

Returns:

int hash code