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

Class LocationProperties

java.lang.Object

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

org.odpi.openmetadata.accessservices.assetmanager.properties.LocationProperties

All Implemented Interfaces:

Serializable

public class LocationProperties
extends ReferenceableProperties

LocationProperties is a class for representing a physical or digital location.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LocationProperties()	Default constructor
LocationProperties(LocationProperties 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	getDescription()	Return the description of the location.
String	getDisplayName()	Return a human memorable name for the location.
int	hashCode()	Return hash code based on properties.
void	setDescription(String description)	Set up the description of the location.
void	setDisplayName(String displayName)	Set up a human memorable name for the location.
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

LocationProperties

public LocationProperties()

Default constructor

LocationProperties

public LocationProperties(LocationProperties template)

Copy/clone constructor.

Parameters:

template - object to copy

Method Details

getDisplayName

public String getDisplayName()

Return a human memorable name for the location.

Returns:

string name

setDisplayName

public void setDisplayName(String displayName)

Set up a human memorable name for the location.

Parameters:

displayName - string name

getDescription

public String getDescription()

Return the description of the location.

Returns:

string text

setDescription

public void setDescription(String description)

Set up the description of the location.

Parameters:

description - 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