Package org.odpi.openmetadata.accessservices.assetmanager.properties

Class SupplementaryProperties

java.lang.Object

org.odpi.openmetadata.accessservices.assetmanager.properties.ReferenceableProperties

org.odpi.openmetadata.accessservices.assetmanager.properties.SupplementaryProperties

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AssetProperties, EndpointProperties, SoftwareCapabilitiesProperties

public class SupplementaryProperties
extends ReferenceableProperties

SupplementaryProperties describe additional information about a technical element (typically assets and schemas) that has been added as part of a governance process.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SupplementaryProperties()	Default constructor
SupplementaryProperties(SupplementaryProperties template)	Copy/clone constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Compare the values of the supplied object with those stored in the current object.
String	getAbbreviation()	Return the abbreviation used for this technical element.
String	getDescription()	Returns the stored description property for the technical element.
String	getDisplayName()	Returns the stored display name property for the technical element.
String	getSummary()	Return the short (1-2 sentence) description of the technical element.
String	getUsage()	Return details of the expected usage of this technical element.
int	hashCode()	Return hash code based on properties.
void	setAbbreviation(String abbreviation)	Set up the abbreviation used for this technical element.
void	setDescription(String description)	Set up the stored description property for the technical element.
void	setDisplayName(String displayName)	Set up the stored display name property for the technical element.
void	setSummary(String summary)	Set up the short (1-2 sentence) description of the technical element.
void	setUsage(String usage)	Set up details of the expected usage of this technical element.
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.accessservices.assetmanager.properties.ReferenceableProperties

getAdditionalProperties, getEffectiveFrom, getEffectiveTo, getExtendedProperties, getQualifiedName, getTypeName, getVendorProperties, setAdditionalProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setQualifiedName, setTypeName, setVendorProperties

Methods inherited from class java.lang.Object

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

Constructor Details

SupplementaryProperties

public SupplementaryProperties()

Default constructor

SupplementaryProperties

public SupplementaryProperties(SupplementaryProperties template)

Copy/clone constructor. Note, this is a deep copy

Parameters:

template - object to copy

Method Details

getDisplayName

public String getDisplayName()

Returns the stored display name property for the technical element. If no display name is available then null is returned.

Returns:

String name

setDisplayName

public void setDisplayName(String displayName)

Set up the stored display name property for the technical element.

Parameters:

displayName - String name

getSummary

public String getSummary()

Return the short (1-2 sentence) description of the technical element.

Returns:

string text

setSummary

public void setSummary(String summary)

Set up the short (1-2 sentence) description of the technical element.

Parameters:

summary - string text

getDescription

public String getDescription()

Returns the stored description property for the technical element. If no description is provided then null is returned.

Returns:

String text

setDescription

public void setDescription(String description)

Set up the stored description property for the technical element.

Parameters:

description - String text

getAbbreviation

public String getAbbreviation()

Return the abbreviation used for this technical element.

Returns:

string text

setAbbreviation

public void setAbbreviation(String abbreviation)

Set up the abbreviation used for this technical element.

Parameters:

abbreviation - string text

getUsage

public String getUsage()

Return details of the expected usage of this technical element.

Returns:

string text

setUsage

public void setUsage(String usage)

Set up details of the expected usage of this technical element.

Parameters:

usage - string text

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()

Return hash code based on properties.

Overrides:

hashCode in class ReferenceableProperties

Returns:

int