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

Class ExternalReferenceProperties

java.lang.Object

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

org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalReferenceProperties

Direct Known Subclasses:

ExternalGlossaryLinkProperties

public class ExternalReferenceProperties
extends ReferenceableProperties

ExternalReferenceProperties describes the properties of URL link to a remote source of information.

Constructor Summary

Constructors

Constructor	Description
ExternalReferenceProperties()	Default constructor
ExternalReferenceProperties(ExternalReferenceProperties 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 external reference to help the reader know if they want to click on the link.
String	getDisplayName()	Return the name for the external reference.
String	getOrganization()	Return the name or identifier or url of the organization that owns the external resource.
String	getUrl()	Return the URL for the external reference.
String	getVersion()	Return the version of the reference that this link refers to.
int	hashCode()	Return hash code based on properties.
void	setDescription(String description)	Set up the description of the external reference to help the reader know if they want to click on the link.
void	setDisplayName(String name)	Set up name of the external reference.
void	setOrganization(String organization)	Set up the name or identifier or url of the organization that owns the external resource.
void	setUrl(String url)	Set up the URL for the external reference.
void	setVersion(String version)	Set up the version of the reference that this link refers to.
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

ExternalReferenceProperties

public ExternalReferenceProperties()

Default constructor

ExternalReferenceProperties

public ExternalReferenceProperties(ExternalReferenceProperties template)

Copy/clone constructor

Parameters:

template - template object to copy.

Method Details

setDisplayName

public void setDisplayName(String name)

Set up name of the external reference.

Parameters:

name - String

getDisplayName

public String getDisplayName()

Return the name for the external reference.

Returns:

String identifier

getUrl

public String getUrl()

Return the URL for the external reference.

Returns:

string URL

setUrl

public void setUrl(String url)

Set up the URL for the external reference.

Parameters:

url - string URL

getVersion

public String getVersion()

Return the version of the reference that this link refers to.

Returns:

string version

setVersion

public void setVersion(String version)

Set up the version of the reference that this link refers to.

Parameters:

version - string version

getDescription

public String getDescription()

Return the description of the external reference to help the reader know if they want to click on the link.

Returns:

string description

setDescription

public void setDescription(String description)

Set up the description of the external reference to help the reader know if they want to click on the link.

Parameters:

description - string description

getOrganization

public String getOrganization()

Return the name or identifier or url of the organization that owns the external resource.

Returns:

string identifier

setOrganization

public void setOrganization(String organization)

Set up the name or identifier or url of the organization that owns the external resource.

Parameters:

organization - string identifier

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