Package org.odpi.openmetadata.accessservices.stewardshipaction.properties

Class SchemaElementProperties

java.lang.Object

org.odpi.openmetadata.accessservices.stewardshipaction.properties.ReferenceableProperties

org.odpi.openmetadata.accessservices.stewardshipaction.properties.SchemaElementProperties

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SchemaAttributeProperties, SchemaTypeProperties

public abstract class SchemaElementProperties
extends ReferenceableProperties

SchemaElementProperties carries the common parameters for creating or updating schema elements such as schema types and attributes.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SchemaElementProperties()	Default constructor
SchemaElementProperties(SchemaElementProperties template)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Return comparison result based on the content of the properties.
String	getDescription()	Return the description of the file.
String	getDisplayName()	Return the display name of the file
boolean	getIsDeprecated()	Is the schema element deprecated?
int	hashCode()	Return hash code for this object
void	setDescription(String description)	Set up the description of the file.
void	setDisplayName(String displayName)	Set up the display name of the file.
void	setIsDeprecated(boolean deprecated)	Set whether the schema element deprecated or not.
String	toString()	JSON-style toString

Methods inherited from class org.odpi.openmetadata.accessservices.stewardshipaction.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

SchemaElementProperties

public SchemaElementProperties()

Default constructor

SchemaElementProperties

public SchemaElementProperties(SchemaElementProperties template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getDisplayName

public String getDisplayName()

Return the display name of the file

Returns:

string name

setDisplayName

public void setDisplayName(String displayName)

Set up the display name of the file.

Parameters:

displayName - string name

getDescription

public String getDescription()

Return the description of the file.

Returns:

string description

setDescription

public void setDescription(String description)

Set up the description of the file.

Parameters:

description - string description

getIsDeprecated

public boolean getIsDeprecated()

Is the schema element deprecated?

Returns:

boolean flag

setIsDeprecated

public void setIsDeprecated(boolean deprecated)

Set whether the schema element deprecated or not. Default is false.

Parameters:

deprecated - boolean flag

toString

public String toString()

JSON-style toString

Overrides:

toString in class ReferenceableProperties

Returns:

return string containing the property names and values

equals

public boolean equals(Object objectToCompare)

Return comparison result based on the content of the properties.

Overrides:

equals in class ReferenceableProperties

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class ReferenceableProperties

Returns:

int hash code