ExternalReference (Governance Program OMAS API 2.5 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.governanceprogram.properties.ExternalReference

All Implemented Interfaces:

Serializable
```
public class ExternalReference
extends Object
implements Serializable
```
ExternalReference stores information about an link to an external resource that is relevant to this asset.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ExternalReference()
Default constructor

ExternalReference(ExternalReference template)
Copy/clone constructor.

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

Method Summary

All Methods Instance Methods Concrete Methods
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,Object>`	`getAdditionalProperties()` Return a copy of the additional properties.
`List<String>`	`getClassifications()` Return the list of classifications associated with the external reference.
`String`	`getDisplayName()` Return the display name of this external reference.
`String`	`getExternalReferenceId()` Return the fully qualified name.
`String`	`getGUID()` Return the unique identifier for the 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`	`getType()`
`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`	`setAdditionalProperties(Map<String,Object> additionalProperties)` Set up additional properties.
`void`	`setClassifications(List<String> classifications)` Set up the classifications associated with this external reference.
`void`	`setDisplayName(String displayName)` Set up the display name of this external reference.
`void`	`setExternalReferenceId(String externalReferenceId)` Set up the fully qualified name.
`void`	`setGUID(String guid)` Set up the unique identifier for the 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`	`setType(String type)`
`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 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
  - getGUID
```
public String getGUID()
```
    Return the unique identifier for the external reference
    
    Returns:
    
    String unique id
  - setGUID
```
public void setGUID(String guid)
```
    Set up the unique identifier for the external reference.
    
    Parameters:
    
    guid - String unique identifier
  - getType
```
public String getType()
```
  - setType
```
public void setType(String type)
```
  - getClassifications
```
public List<String> getClassifications()
```
    Return the list of classifications associated with the external reference.
    
    Returns:
    
    Classifications list of classifications
  - setClassifications
```
public void setClassifications(List<String> classifications)
```
    Set up the classifications associated with this external reference.
    
    Parameters:
    
    classifications - list of classifications
  - getExternalReferenceId
```
public String getExternalReferenceId()
```
    Return the fully qualified name.
    
    Returns:
    
    String externalReferenceId
  - setExternalReferenceId
```
public void setExternalReferenceId(String externalReferenceId)
```
    Set up the fully qualified name.
    
    Parameters:
    
    externalReferenceId - String identifier
  - 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
  - setAdditionalProperties
```
public void setAdditionalProperties(Map<String,Object> additionalProperties)
```
    Set up additional properties.
    
    Parameters:
    
    additionalProperties - Additional properties object
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
    Return a copy of the additional properties. Null means no additional properties are available.
    
    Returns:
    
    AdditionalProperties
  - toString
```
public String toString()
```
    Standard toString method.
    
    Overrides:
    
    toString in class Object
    
    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 Object
    
    Parameters:
    
    objectToCompare - supplied object
    
    Returns:
    
    boolean result of comparison
  - hashCode
```
public int hashCode()
```
    Uses the guid to create a hashcode.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    int hash code

Class ExternalReference

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExternalReference

ExternalReference

Method Detail

getGUID

setGUID

getType

setType

getClassifications

setClassifications

getExternalReferenceId

setExternalReferenceId

getLocalReferenceId

setLocalReferenceId

getDisplayName

setDisplayName

getLinkDescription

setLinkDescription

getResourceDescription

setResourceDescription

getURI

setURI

getVersion

setVersion

getOrganization

setOrganization

setAdditionalProperties

getAdditionalProperties

toString

equals

hashCode