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

Class AlsoKnownAsReference

java.lang.Object

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

org.odpi.openmetadata.accessservices.subjectarea.generated.references.ReferenceableToExternalId.AlsoKnownAsReference

All Implemented Interfaces:

Serializable

public class AlsoKnownAsReference
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 AlsoKnownAsReference. It is used in type Referenceable to represent a reference to an OMAS entity of type externalId. 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 ExternalId	externalId
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
AlsoKnownAsReference()
AlsoKnownAsReference(Map objIdMap)
AlsoKnownAsReference(Reference other)
AlsoKnownAsReference(String guid)
AlsoKnownAsReference(String relatedEndType, Map<String,Object> uniqueAttributes)
AlsoKnownAsReference(String entityGuid, OMRSLine line) Populate the reference from a relationship
AlsoKnownAsReference(String guid, String relatedEndType)
AlsoKnownAsReference(String guid, String relatedEndType, Map<String,Object> uniqueAttributes)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDescription() Description of how the external identifier relates to the resource.
ExternalId	getExternalId()
String	getSource() Details of where the external identifier was sourced from.
String	getUsage() Description of how the external identifier can be used.
int	hashCode()
void	setDescription(String description)
void	setExternalId(ExternalId externalId)
void	setSource(String source)
void	setUsage(String usage)
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

externalId

protected ExternalId externalId

Constructor Detail

AlsoKnownAsReference

public AlsoKnownAsReference()

AlsoKnownAsReference

public AlsoKnownAsReference(String guid)

AlsoKnownAsReference

public AlsoKnownAsReference(String guid,
                            String relatedEndType)

AlsoKnownAsReference

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

AlsoKnownAsReference

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

AlsoKnownAsReference

public AlsoKnownAsReference(Reference other)

AlsoKnownAsReference

public AlsoKnownAsReference(String entityGuid,
                            OMRSLine line)

Populate the reference from a relationship

Parameters:

entityGuid - String entity Guid

line - OMRSLine

AlsoKnownAsReference

public AlsoKnownAsReference(Map objIdMap)

Method Detail

getExternalId

public ExternalId getExternalId()

setExternalId

public void setExternalId(ExternalId externalId)

getDescription

public String getDescription()

Description of how the external identifier relates to the resource.

Returns:

Description

setDescription

public void setDescription(String description)

getUsage

public String getUsage()

Description of how the external identifier can be used.

Returns:

Usage

setUsage

public void setUsage(String usage)

getSource

public String getSource()

Details of where the external identifier was sourced from.

Returns:

Source

setSource

public void setSource(String source)

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