Package org.odpi.openmetadata.accessservices.governanceprogram.properties

Class ExternalReferenceProperties

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.properties.ReferenceableProperties

org.odpi.openmetadata.accessservices.governanceprogram.properties.ExternalReferenceProperties

All Implemented Interfaces:

Serializable

public class ExternalReferenceProperties
extends ReferenceableProperties

ExternalReferenceProperties stores information about an link to an external resource that is relevant to this element.

See Also:

• Serialized Form

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	getDisplayName()	Return the display name of this external reference.
String	getLinkDescription()	Return the description of the reference (with respect to this governance definition).
String	getLocalReferenceId()	Return the identifier given to this reference (with respect to this governance definition).
String	getOrganization()	Return the name of the organization that owns the resource that this external reference represents.
String	getResourceDescription()	Return the description of the resource that this external reference represents.
String	getURI()	Return the URI used to retrieve the resource that this external reference represents.
String	getVersion()	Return the version of the resource that this external reference represents.
int	hashCode()	Uses the guid to create a hashcode.
void	setDisplayName(String displayName)	Set up the display name of this external reference.
void	setLinkDescription(String linkDescription)	Set up the description of the reference (with respect to the governance definition this reference is linked to).
void	setLocalReferenceId(String localReferenceId)	Set up the identifier given to this reference (with respect to this governance definition).
void	setOrganization(String organization)	Set up the name of the organization that owns the resource that this external reference represents.
void	setResourceDescription(String resourceDescription)	Set up the description of the resource that this external reference represents.
void	setURI(String uri)	Set up the URI used to retrieve the resource that this external reference represents.
void	setVersion(String version)	Set up the version of the resource that this external reference represents.
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.accessservices.governanceprogram.properties.ReferenceableProperties

getAdditionalProperties, getEffectiveFrom, getEffectiveTo, getExtendedProperties, getQualifiedName, getTypeName, setAdditionalProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setQualifiedName, setTypeName

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 - element to copy

Method Details

getLocalReferenceId

public String getLocalReferenceId()

Return the identifier given to this reference (with respect to this governance definition).

Returns:

localReferenceId

setLocalReferenceId

public void setLocalReferenceId(String localReferenceId)

Set up the identifier given to this reference (with respect to this governance definition).

Parameters:

localReferenceId - String name

getDisplayName

public String getDisplayName()

Return the display name of this external reference.

Returns:

String display name.

setDisplayName

public void setDisplayName(String displayName)

Set up the display name of this external reference.

Parameters:

displayName - - string name

getLinkDescription

public String getLinkDescription()

Return the description of the reference (with respect to this governance definition).

Returns:

String link description.

setLinkDescription

public void setLinkDescription(String linkDescription)

Set up the description of the reference (with respect to the governance definition this reference is linked to).

Parameters:

linkDescription - String description

getResourceDescription

public String getResourceDescription()

Return the description of the resource that this external reference represents.

Returns:

String description

setResourceDescription

public void setResourceDescription(String resourceDescription)

Set up the description of the resource that this external reference represents.

Parameters:

resourceDescription - String description

getURI

public String getURI()

Return the URI used to retrieve the resource that this external reference represents.

Returns:

String URI

setURI

public void setURI(String uri)

Set up the URI used to retrieve the resource that this external reference represents.

Parameters:

uri - String URI

getVersion

public String getVersion()

Return the version of the resource that this external reference represents.

Returns:

String version identifier

setVersion

public void setVersion(String version)

Set up the version of the resource that this external reference represents.

Parameters:

version - String identifier

getOrganization

public String getOrganization()

Return the name of the organization that owns the resource that this external reference represents.

Returns:

String organization name

setOrganization

public void setOrganization(String organization)

Set up the name of the organization that owns the resource that this external reference represents.

Parameters:

organization - String name

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()

Uses the guid to create a hashcode.

Overrides:

hashCode in class ReferenceableProperties

Returns:

int hash code