Class ValidValueSetProperties
- java.lang.Object
-
- org.odpi.openmetadata.accessservices.datamanager.properties.ReferenceableProperties
-
- org.odpi.openmetadata.accessservices.datamanager.properties.ValidValueSetProperties
-
- All Implemented Interfaces:
Serializable
public class ValidValueSetProperties extends ReferenceableProperties
ValidValueSetProperties provides the class for ValidValueSet.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ValidValueSetProperties()
ConstructorValidValueSetProperties(ValidValueSetProperties template)
Copy/clone constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object objectToCompare)
Compare the values of the supplied object with those stored in the current object.String
getDescription()
Returns the stored description property for the valid value.String
getDisplayName()
Returns the stored display name property for the valid value.boolean
getIsDeprecated()
Is the valid value deprecated?String
getPreferredValue()
Return the preferred values to use in implementations (normally used with definitions)String
getScope()
Return the scope of values that this valid value covers (normally used with sets)String
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
setScope(String scope)
Set up the scope of values that this valid value covers (normally used with sets)void
setUsage(String usage)
Set up the description of how this valid value should be used.String
toString()
Generate a string containing the properties.-
Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.ReferenceableProperties
getAdditionalProperties, getEffectiveFrom, getEffectiveTo, getExtendedProperties, getQualifiedName, getTypeName, getVendorProperties, setAdditionalProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setQualifiedName, setTypeName, setVendorProperties
-
-
-
-
Constructor Detail
-
ValidValueSetProperties
public ValidValueSetProperties()
Constructor
-
ValidValueSetProperties
public ValidValueSetProperties(ValidValueSetProperties template)
Copy/clone constructor- Parameters:
template
- object to copy
-
-
Method Detail
-
getDisplayName
public String 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
public void setDisplayName(String displayName)
Set up the stored display name property for the valid value.- Parameters:
displayName
- String name
-
getDescription
public String getDescription()
Returns the stored description property for the valid value. If no description is provided then null is returned.- Returns:
- description String text
-
setDescription
public void setDescription(String description)
Set up the stored description property associated with the valid value.- Parameters:
description
- String text
-
getUsage
public String getUsage()
Return the description of how this valid value should be used.- Returns:
- String text
-
setUsage
public void setUsage(String usage)
Set up the description of how this valid value should be used.- Parameters:
usage
- String text
-
getScope
public String getScope()
Return the scope of values that this valid value covers (normally used with sets)- Returns:
- String text
-
setScope
public void setScope(String scope)
Set up the scope of values that this valid value covers (normally used with sets)- Parameters:
scope
- String text
-
getPreferredValue
public String getPreferredValue()
Return the preferred values to use in implementations (normally used with definitions)- Returns:
- String value
-
setPreferredValue
public void setPreferredValue(String preferredValue)
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
public String toString()
Generate a string containing the properties.- Overrides:
toString
in classReferenceableProperties
- Returns:
- string value
-
equals
public boolean equals(Object objectToCompare)
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
-
-