Class ValidValueProperties
java.lang.Object
org.odpi.openmetadata.accessservices.communityprofile.properties.ReferenceableProperties
org.odpi.openmetadata.accessservices.communityprofile.properties.ValidValueProperties
ValidValueProperties provides the common super class for ValidValueSet and ValidValueDefinition.
-
Constructor Summary
ConstructorsConstructorDescriptionConstructorValidValueProperties
(ValidValueProperties template) Copy/clone constructor -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compare the values of the supplied object with those stored in the current object.Returns the stored description property for the valid value.Returns the stored display name property for the valid value.boolean
Is the valid value deprecated?Return the preferred values to use in implementations (normally used with definitions)getScope()
Return the scope of values that this valid value covers (normally used with sets)getUsage()
Return the description of how this valid value should be used.int
hashCode()
Return hash code based on properties.void
setDescription
(String description) Set up the stored description property associated with the valid value.void
setDisplayName
(String displayName) Set up the stored display name property for the valid value.void
setIsDeprecated
(boolean deprecated) Set whether the valid value is deprecated or not.void
setPreferredValue
(String preferredValue) Set up the preferred values to use in implementations (normally used with definitions)void
Set up the scope of values that this valid value covers (normally used with sets)void
Set up the description of how this valid value should be used.toString()
Generate a string containing the properties.Methods inherited from class org.odpi.openmetadata.accessservices.communityprofile.properties.ReferenceableProperties
getAdditionalProperties, getEffectiveFrom, getEffectiveTo, getExtendedProperties, getQualifiedName, getTypeName, getVendorProperties, setAdditionalProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setQualifiedName, setTypeName, setVendorProperties
-
Constructor Details
-
ValidValueProperties
public ValidValueProperties()Constructor -
ValidValueProperties
Copy/clone constructor- Parameters:
template
- object to copy
-
-
Method Details
-
getDisplayName
Returns the stored display name property for the valid value. If no display name is available then null is returned.- Returns:
- String name
-
setDisplayName
Set up the stored display name property for the valid value.- Parameters:
displayName
- String name
-
getDescription
Returns the stored description property for the valid value. If no description is provided then null is returned.- Returns:
- description String text
-
setDescription
Set up the stored description property associated with the valid value.- Parameters:
description
- String text
-
getUsage
Return the description of how this valid value should be used.- Returns:
- String text
-
setUsage
Set up the description of how this valid value should be used.- Parameters:
usage
- String text
-
getScope
Return the scope of values that this valid value covers (normally used with sets)- Returns:
- String text
-
setScope
Set up the scope of values that this valid value covers (normally used with sets)- Parameters:
scope
- String text
-
getPreferredValue
Return the preferred values to use in implementations (normally used with definitions)- Returns:
- String value
-
setPreferredValue
Set up the preferred values to use in implementations (normally used with definitions)- Parameters:
preferredValue
- String value
-
getIsDeprecated
public boolean getIsDeprecated()Is the valid value deprecated?- Returns:
- boolean flag
-
setIsDeprecated
public void setIsDeprecated(boolean deprecated) Set whether the valid value is deprecated or not. Default is false.- Parameters:
deprecated
- boolean flag
-
toString
Generate a string containing the properties.- Overrides:
toString
in classReferenceableProperties
- Returns:
- string value
-
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
-