org.odpi.openmetadata.accessservices.subjectarea.generated.references.ReferenceableToExternalReference

Class ExternalReferenceReference

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.Reference

org.odpi.openmetadata.accessservices.subjectarea.generated.references.ReferenceableToExternalReference.ExternalReferenceReference

All Implemented Interfaces:

Serializable

public class ExternalReferenceReference
extends Reference
implements Serializable

This is a reference, which is a view of a relationship from the perspective of one of the ends. A relationship is the link between 2 OMAS entities. A reference is used when working with OMAS entity APIs. An OMAS entity has attributes, classifications and references. This Reference is called ExternalReferenceReference. It is used in type Referenceable to represent a reference to an OMAS entity of type externalReference. The reference also contains information about the relationship; the relationship guid, name, relationship attributes and a list of unique attributes. Relationship attributes are attributes of the relationship. It is possible to work with the relationship itself using the OMAS API using the relationship guid contained in this reference.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ExternalReference	externalReference
protected String	name
protected static String	relationship_Type

Fields inherited from class org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.Reference

KEY_RELATED_END_GUID, KEY_RELATIONSHIP_GUID, KEY_TYPENAME, KEY_UNIQUE_ATTRIBUTES, referenceName, relatedEndGuid, relatedEndType, relationshipGuid, uniqueAttributes

Constructor Summary

Constructors

Constructor and Description
ExternalReferenceReference()
ExternalReferenceReference(Map objIdMap)
ExternalReferenceReference(Reference other)
ExternalReferenceReference(String guid)
ExternalReferenceReference(String relatedEndType, Map<String,Object> uniqueAttributes)
ExternalReferenceReference(String entityGuid, OMRSLine line) Populate the reference from a relationship
ExternalReferenceReference(String guid, String relatedEndType)
ExternalReferenceReference(String guid, String relatedEndType, Map<String,Object> uniqueAttributes)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDescription() Description of the relevance of this reference to the linked item.
ExternalReference	getExternalReference()
String	getReferenceId() Local identifier for the reference.
int	hashCode()
void	setDescription(String description)
void	setExternalReference(ExternalReference externalReference)
void	setReferenceId(String referenceId)
StringBuilder	toString(StringBuilder sb)

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.Reference

getReferenceName, getRelatedEndGuid, getRelatedEndType, getRelationship_Type, getRelationshipAttributes, getRelationshipGuid, getUniqueAttributes, setReferenceName, setRelatedEndGuid, setRelatedEndType, setRelationship_Type, setRelationshipAttributes, setRelationshipGuid, setUniqueAttributes, toString

Methods inherited from class java.lang.Object

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

Field Detail

relationship_Type

protected static final String relationship_Type

See Also:

Constant Field Values

name

protected String name

externalReference

protected ExternalReference externalReference

Constructor Detail

ExternalReferenceReference

public ExternalReferenceReference()

ExternalReferenceReference

public ExternalReferenceReference(String guid)

ExternalReferenceReference

public ExternalReferenceReference(String guid,
                                  String relatedEndType)

ExternalReferenceReference

public ExternalReferenceReference(String relatedEndType,
                                  Map<String,Object> uniqueAttributes)

ExternalReferenceReference

public ExternalReferenceReference(String guid,
                                  String relatedEndType,
                                  Map<String,Object> uniqueAttributes)

ExternalReferenceReference

public ExternalReferenceReference(Reference other)

ExternalReferenceReference

public ExternalReferenceReference(String entityGuid,
                                  OMRSLine line)

Populate the reference from a relationship

Parameters:

entityGuid - String entity Guid

line - OMRSLine

ExternalReferenceReference

public ExternalReferenceReference(Map objIdMap)

Method Detail

getExternalReference

public ExternalReference getExternalReference()

setExternalReference

public void setExternalReference(ExternalReference externalReference)

getReferenceId

public String getReferenceId()

Local identifier for the reference.

Returns:

ReferenceId

setReferenceId

public void setReferenceId(String referenceId)

getDescription

public String getDescription()

Description of the relevance of this reference to the linked item.

Returns:

Description

setDescription

public void setDescription(String description)

toString

public StringBuilder toString(StringBuilder sb)

Overrides:

toString in class Reference

equals

public boolean equals(Object o)

Overrides:

equals in class Reference

hashCode

public int hashCode()

Overrides:

hashCode in class Reference