Class SupplementaryProperties
java.lang.Object
org.odpi.openmetadata.accessservices.stewardshipaction.properties.ReferenceableProperties
org.odpi.openmetadata.accessservices.stewardshipaction.properties.SupplementaryProperties
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
AssetProperties
SupplementaryProperties describe additional information about a technical element (typically assets and schemas)
that has been added as part of a governance process.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorCopy/clone constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compare the values of the supplied object with those stored in the current object.Return the abbreviation used for this technical element.Returns the stored description property for the technical element.Returns the stored display name property for the technical element.Return the short (1-2 sentence) description of the technical element.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
Set up details of the expected usage of this technical element.toString()
Standard toString method.Methods inherited from class org.odpi.openmetadata.accessservices.stewardshipaction.properties.ReferenceableProperties
getAdditionalProperties, getEffectiveFrom, getEffectiveTo, getExtendedProperties, getQualifiedName, getTypeName, setAdditionalProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setQualifiedName, setTypeName
-
Constructor Details
-
SupplementaryProperties
public SupplementaryProperties()Default constructor -
SupplementaryProperties
Copy/clone constructor. Note, this is a deep copy- Parameters:
template
- object to copy
-
-
Method Details
-
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
Set up the stored display name property for the technical element.- Parameters:
displayName
- String name
-
getSummary
Return the short (1-2 sentence) description of the technical element.- Returns:
- string text
-
setSummary
Set up the short (1-2 sentence) description of the technical element.- Parameters:
summary
- string text
-
getDescription
Returns the stored description property for the technical element. If no description is provided then null is returned.- Returns:
- String text
-
setDescription
Set up the stored description property for the technical element.- Parameters:
description
- String text
-
getAbbreviation
Return the abbreviation used for this technical element.- Returns:
- string text
-
setAbbreviation
Set up the abbreviation used for this technical element.- Parameters:
abbreviation
- string text
-
getUsage
Return details of the expected usage of this technical element.- Returns:
- string text
-
setUsage
Set up details of the expected usage of this technical element.- Parameters:
usage
- string text
-
toString
Standard toString method.- Overrides:
toString
in classReferenceableProperties
- Returns:
- print out of variables in a JSON-style
-
equals
Compare the values of the supplied object with those stored in the current object.- Overrides:
equals
in classReferenceableProperties
- Parameters:
objectToCompare
- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Return hash code based on properties.- Overrides:
hashCode
in classReferenceableProperties
- Returns:
- int
-