org.odpi.openmetadata.accessservices.assetconsumer.properties

Class ReferenceableHeader

java.lang.Object

org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetConsumerElementHeader

org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableHeader

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Asset, GlossaryTerm

public abstract class ReferenceableHeader
extends AssetConsumerElementHeader

ReferenceableHeader provides the common properties found in objects that inherit from Referenceable.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReferenceableHeader() Default constructor
ReferenceableHeader(ReferenceableHeader template) Copy/clone constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Return comparison result based on the content of the properties.
Map<String,Object>	getAdditionalProperties() Return any additional properties associated with the asset.
List<ReferenceableClassification>	getClassifications() Return the list of active classifications for this asset.
String	getGUID() Return the unique identifier for this asset.
String	getOriginId() Return the unique identifier of this metadata element's origin (also known as the home metadata collection id).
String	getOriginLicense() Return the license for the metadata element set up by the origin.
String	getOriginName() Set up the name of the metadata element's origin.
String	getOriginType() Return the type of the metadata element's origin.
String	getQualifiedName() Return the unique name for this asset.
String	getTypeDescription() Return the description for this Asset's type.
String	getTypeName() Return the name for this Asset's type.
int	hashCode() Return hash code for this object
void	setAdditionalProperties(Map<String,Object> additionalProperties) Set up any additional properties associated with the asset.
void	setClassifications(List<ReferenceableClassification> classifications) Set up the list of active classifications for this asset.
void	setGUID(String guid) Set up the unique identifier for this asset.
void	setOriginId(String originId) Set up the unique identifier of this metadata element's origin (also known as the home metadata collection id).
void	setOriginLicense(String originLicense) Set up the license for the metadata element set up by the origin.
void	setOriginName(String originName) Return the name of the metadata element's origin.
void	setOriginType(String originType) Set up the type of the metadata element's origin.
void	setQualifiedName(String qualifiedName) Set up the unique name for this asset.
void	setTypeDescription(String typeDescription) Set up the description for this Asset's type.
void	setTypeName(String typeName) Set up the name for this Asset's type.
String	toString() JSON-style toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceableHeader

public ReferenceableHeader()

Default constructor

ReferenceableHeader

public ReferenceableHeader(ReferenceableHeader template)

Copy/clone constructor

Method Detail

getGUID

public String getGUID()

Return the unique identifier for this asset.

Returns:

string guid

setGUID

public void setGUID(String guid)

Set up the unique identifier for this asset.

Parameters:

guid - string guid for this asset

getTypeName

public String getTypeName()

Return the name for this Asset's type.

Returns:

string name

setTypeName

public void setTypeName(String typeName)

Set up the name for this Asset's type.

Parameters:

typeName - string name

getTypeDescription

public String getTypeDescription()

Return the description for this Asset's type.

Returns:

string description

getOriginId

public String getOriginId()

Return the unique identifier of this metadata element's origin (also known as the home metadata collection id).

Returns:

guid

setOriginId

public void setOriginId(String originId)

Set up the unique identifier of this metadata element's origin (also known as the home metadata collection id).

Parameters:

originId - guid

getOriginName

public String getOriginName()

Set up the name of the metadata element's origin. This may be null.

Returns:

name

setOriginName

public void setOriginName(String originName)

Return the name of the metadata element's origin. This may be null.

Parameters:

originName - name

getOriginType

public String getOriginType()

Return the type of the metadata element's origin.

Returns:

descriptive type name

setOriginType

public void setOriginType(String originType)

Set up the type of the metadata element's origin.

Parameters:

originType - descriptive type name

getOriginLicense

public String getOriginLicense()

Return the license for the metadata element set up by the origin. Null means unrestricted.

Returns:

license string

setOriginLicense

public void setOriginLicense(String originLicense)

Set up the license for the metadata element set up by the origin. Null means unrestricted.

Parameters:

originLicense -

setTypeDescription

public void setTypeDescription(String typeDescription)

Set up the description for this Asset's type.

Parameters:

typeDescription - string description

getQualifiedName

public String getQualifiedName()

Return the unique name for this asset.

Returns:

string name

setQualifiedName

public void setQualifiedName(String qualifiedName)

Set up the unique name for this asset.

Parameters:

qualifiedName - string name

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return any additional properties associated with the asset.

Returns:

map of property names to property values

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)

Set up any additional properties associated with the asset.

Parameters:

additionalProperties - map of property names to property values

getClassifications

public List<ReferenceableClassification> getClassifications()

Return the list of active classifications for this asset.

Returns:

list of classification objects

setClassifications

public void setClassifications(List<ReferenceableClassification> classifications)

Set up the list of active classifications for this asset.

Parameters:

classifications - list of classification objects

toString

public String toString()

JSON-style toString

Overrides:

toString in class Object

Returns:

return string containing the property names and values

equals

public boolean equals(Object objectToCompare)

Return comparison result based on the content of the properties.

Overrides:

equals in class Object

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class Object

Returns:

int hash code