Class ExternalReference
- java.lang.Object
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.ExternalReference
-
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
RelatedMediaReference
public class ExternalReference extends Referenceable
ExternalReference stores information about an link to an external resource that is relevant to this asset.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected StringdisplayNameprotected StringlinkDescriptionprotected Stringorganizationprotected StringreferenceIdprotected StringresourceDescriptionprotected Stringuriprotected Stringversion-
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
additionalProperties, qualifiedName
-
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
extendedProperties, url
-
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
CURRENT_AUDIT_HEADER_VERSION
-
-
Constructor Summary
Constructors Constructor Description ExternalReference()Default constructorExternalReference(ExternalReference templateExternalReference)Copy/clone constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object objectToCompare)Compare the values of the supplied object with those stored in the current object.StringgetDisplayName()Return the display name of this external reference.StringgetLinkDescription()Return the description of the reference (with respect to this asset).StringgetOrganization()Return the name of the organization that owns the resource that this external reference represents.StringgetReferenceId()Return the identifier given to this reference (with respect to this asset).StringgetResourceDescription()Return the description of the resource that this external reference represents.StringgetURI()Return the URI used to retrieve the resource that this external reference represents.StringgetVersion()Return the version of the resource that this external reference represents.inthashCode()Hash of propertiesvoidsetDisplayName(String displayName)Set up the display name of this external reference.voidsetLinkDescription(String linkDescription)Set up the description of the reference (with respect to the element this reference is linked to).voidsetOrganization(String organization)Set up the name of the organization that owns the resource that this external reference represents.voidsetReferenceId(String referenceId)Set up the identifier given to this reference (with respect to this asset).voidsetResourceDescription(String resourceDescription)voidsetURI(String uri)Set up the URI used to retrieve the resource that this external reference represents.voidsetVersion(String version)Set up the version of the resource that this external reference represents.StringtoString()Standard toString method.-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
getAdditionalProperties, getQualifiedName, setAdditionalProperties, setQualifiedName
-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
getExtendedProperties, getURL, setExtendedProperties, setURL
-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
getClassifications, getGUID, setClassifications, setGUID
-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
getOrigin, getStatus, getType, getVersions, setOrigin, setStatus, setType, setVersions
-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
getHeaderVersion, setHeaderVersion
-
-
-
-
Field Detail
-
referenceId
protected String referenceId
-
linkDescription
protected String linkDescription
-
displayName
protected String displayName
-
uri
protected String uri
-
resourceDescription
protected String resourceDescription
-
version
protected String version
-
organization
protected String organization
-
-
Constructor Detail
-
ExternalReference
public ExternalReference()
Default constructor
-
ExternalReference
public ExternalReference(ExternalReference templateExternalReference)
Copy/clone constructor.- Parameters:
templateExternalReference- element to copy
-
-
Method Detail
-
getReferenceId
public String getReferenceId()
Return the identifier given to this reference (with respect to this asset).- Returns:
- String referenceId
-
setReferenceId
public void setReferenceId(String referenceId)
Set up the identifier given to this reference (with respect to this asset).- Parameters:
referenceId- String identifier
-
getLinkDescription
public String getLinkDescription()
Return the description of the reference (with respect to this asset).- Returns:
- String link description.
-
setLinkDescription
public void setLinkDescription(String linkDescription)
Set up the description of the reference (with respect to the element this reference is linked to).- Parameters:
linkDescription- String description
-
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
-
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
-
getResourceDescription
public String getResourceDescription()
Return the description of the resource that this external reference represents.- Returns:
- String resource description
-
setResourceDescription
public void setResourceDescription(String resourceDescription)
-
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:
toStringin classReferenceable- 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:
equalsin classReferenceable- Parameters:
objectToCompare- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()
Hash of properties- Overrides:
hashCodein classReferenceable- Returns:
- int
-
-