Package org.odpi.openmetadata.frameworks.openmetadata.properties.externalreferences

Class ExternalReferenceLinkProperties

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties

org.odpi.openmetadata.frameworks.openmetadata.properties.externalreferences.ExternalReferenceLinkProperties

public class ExternalReferenceLinkProperties
extends RelationshipProperties

ExternalReferenceLinkProperties provides a structure for the properties that link an external reference to an object.

Constructor Summary

Constructors

Constructor	Description
ExternalReferenceLinkProperties()	Default constructor
ExternalReferenceLinkProperties(ExternalReferenceLinkProperties template)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Equals method that returns true if containing properties are the same.
String	getLinkDescription()	Return the description of the external reference with respect to the linked object.
String	getLinkId()	Return the identifier that this reference is to be known as with respect to the linked object.
String	getPages()	Return the page range for the reference.
int	hashCode()	Return hash code for this object
void	setLinkDescription(String linkDescription)	Set up the description of the external reference with respect to the linked object.
void	setLinkId(String linkId)	Set up the identifier that this reference is to be known as with respect to the linked object.
void	setPages(String pages)	Set up the page range for the reference.
String	toString()	JSON-style toString.

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties

getEffectiveFrom, getEffectiveTo, getExtendedProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ExternalReferenceLinkProperties

public ExternalReferenceLinkProperties()

Default constructor

ExternalReferenceLinkProperties

public ExternalReferenceLinkProperties(ExternalReferenceLinkProperties template)

Copy/clone constructor

Parameters:

template - object to copy

Method Details

getLinkId

public String getLinkId()

Return the identifier that this reference is to be known as with respect to the linked object.

Returns:

String identifier

setLinkId

public void setLinkId(String linkId)

Set up the identifier that this reference is to be known as with respect to the linked object.

Parameters:

linkId - String identifier

getLinkDescription

public String getLinkDescription()

Return the description of the external reference with respect to the linked object.

Returns:

string

setLinkDescription

public void setLinkDescription(String linkDescription)

Set up the description of the external reference with respect to the linked object.

Parameters:

linkDescription - string

getPages

public String getPages()

Return the page range for the reference.

Returns:

string

setPages

public void setPages(String pages)

Set up the page range for the reference.

Parameters:

pages - string

toString

public String toString()

JSON-style toString.

Overrides:

toString in class RelationshipProperties

Returns:

list of properties and their values.

equals

public boolean equals(Object objectToCompare)

Equals method that returns true if containing properties are the same.

Overrides:

equals in class RelationshipProperties

Parameters:

objectToCompare - object to compare

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class RelationshipProperties

Returns:

int hash code