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

Class ResourceReference

java.lang.Object

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

org.odpi.openmetadata.accessservices.subjectarea.generated.references.ExternalIdToReferenceable.ResourceReference

All Implemented Interfaces:

Serializable

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

referenceable

protected Referenceable referenceable

Constructor Detail

ResourceReference

public ResourceReference()

ResourceReference

public ResourceReference(String guid)

ResourceReference

public ResourceReference(String guid,
                         String relatedEndType)

ResourceReference

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

ResourceReference

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

ResourceReference

public ResourceReference(Reference other)

ResourceReference

public ResourceReference(String entityGuid,
                         OMRSLine line)

Populate the reference from a relationship

Parameters:

entityGuid - String entity Guid

line - OMRSLine

ResourceReference

public ResourceReference(Map objIdMap)

Method Detail

getReferenceable

public Referenceable getReferenceable()

setReferenceable

public void setReferenceable(Referenceable referenceable)

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