org.odpi.openmetadata.accessservices.communityprofile.properties

Class ExternalReference

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.properties.CommunityProfileElementHeader

org.odpi.openmetadata.accessservices.communityprofile.properties.CommonHeader

org.odpi.openmetadata.accessservices.communityprofile.properties.ExternalReference

All Implemented Interfaces:

Serializable

public class ExternalReference
extends CommonHeader

ExternalReference stores information about an link to an external resource that is relevant to a personal profile or a community.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExternalReference() Default constructor
ExternalReference(ExternalReference template) Copy/clone constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
Map<String,String>	getAdditionalProperties() Return any additional properties associated with the element.
Map<String,Object>	getExtendedProperties() Return any properties associated with the subclass of this element.
String	getLinkDescription() Return the description of the reference (with respect to the element that this reference is linked to).
String	getLinkId() Return the identifier given to this reference (with respect to this element).
String	getOwningOrganization() 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	getResourceDisplayName() Return the display name of this external reference.
String	getResourceId() Return the fully qualified name.
String	getResourceURL() Return the URL used to retrieve the resource that this external reference represents.
String	getResourceVersion() Return the version of the resource that this external reference represents.
int	hashCode() Uses the guid to create a hashcode.
void	setAdditionalProperties(Map<String,String> additionalProperties) Set up any additional properties associated with the element.
void	setExtendedProperties(Map<String,Object> additionalProperties) Set up any additional properties associated with the element.
void	setLinkDescription(String linkDescription) Set up the description of the reference (with respect to the element that this reference is linked to).
void	setLinkId(String linkId) Set up the identifier given to this reference (with respect to this element).
void	setOwningOrganization(String owningOrganization) 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	setResourceDisplayName(String name) Set up the display name of this external reference.
void	setResourceId(String resourceId) Set up the fully qualified name.
void	setResourceURL(String url) Set up the URL used to retrieve the resource that this external reference represents.
void	setResourceVersion(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.communityprofile.properties.CommonHeader

getGUID, setGUID

Methods inherited from class org.odpi.openmetadata.accessservices.communityprofile.properties.CommunityProfileElementHeader

getOriginId, getOriginLicense, getOriginName, getOriginType, getTypeDescription, getTypeName, setOriginId, setOriginLicense, setOriginName, setOriginType, setTypeDescription, setTypeName

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalReference

public ExternalReference()

Default constructor

ExternalReference

public ExternalReference(ExternalReference template)

Copy/clone constructor.

Parameters:

template - element to copy

Method Detail

getLinkId

public String getLinkId()

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

Returns:

linkId

setLinkId

public void setLinkId(String linkId)

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

Parameters:

linkId - String name

getLinkDescription

public String getLinkDescription()

Return the description of the reference (with respect to the element that this reference is linked to).

Returns:

String link description.

setLinkDescription

public void setLinkDescription(String linkDescription)

Set up the description of the reference (with respect to the element that this reference is linked to).

Parameters:

linkDescription - String description

getResourceId

public String getResourceId()

Return the fully qualified name.

Returns:

String resourceId

setResourceId

public void setResourceId(String resourceId)

Set up the fully qualified name.

Parameters:

resourceId - String identifier

getResourceDisplayName

public String getResourceDisplayName()

Return the display name of this external reference.

Returns:

String display name.

setResourceDisplayName

public void setResourceDisplayName(String name)

Set up the display name of this external reference.

Parameters:

name - - string name

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

getResourceURL

public String getResourceURL()

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

Returns:

String URL

setResourceURL

public void setResourceURL(String url)

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

Parameters:

url - String URL

getResourceVersion

public String getResourceVersion()

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

Returns:

String version identifier

setResourceVersion

public void setResourceVersion(String version)

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

Parameters:

version - String identifier

getOwningOrganization

public String getOwningOrganization()

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

Returns:

String organization name

setOwningOrganization

public void setOwningOrganization(String owningOrganization)

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

Parameters:

owningOrganization - String name

getExtendedProperties

public Map<String,Object> getExtendedProperties()

Return any properties associated with the subclass of this element.

Returns:

map of property names to property values

setExtendedProperties

public void setExtendedProperties(Map<String,Object> additionalProperties)

Set up any additional properties associated with the element.

Parameters:

additionalProperties - map of property names to property values

getAdditionalProperties

public Map<String,String> getAdditionalProperties()

Return any additional properties associated with the element.

Returns:

map of property names to property values

setAdditionalProperties

public void setAdditionalProperties(Map<String,String> additionalProperties)

Set up any additional properties associated with the element.

Parameters:

additionalProperties - map of property names to property values

toString

public String toString()

Standard toString method.

Overrides:

toString in class CommonHeader

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 CommonHeader

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Uses the guid to create a hashcode.

Overrides:

hashCode in class CommonHeader

Returns:

int hash code