org.odpi.openmetadata.frameworks.governanceaction.properties

Class ElementClassificationHeader

java.lang.Object

org.odpi.openmetadata.frameworks.governanceaction.properties.ElementControlHeader

org.odpi.openmetadata.frameworks.governanceaction.properties.ElementClassificationHeader

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ElementClassification

public class ElementClassificationHeader
extends ElementControlHeader

The ElementClassificationHeader bean describes the header for a classification associated with an element. The ElementClassification is a generic classification.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.governanceaction.properties.ElementControlHeader

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
ClassificationOrigin	getClassificationOrigin() Return whether the classification was added explicitly to this asset or propagated from another entity.
String	getClassificationOriginGUID() Return the entity guid that the classification was propagated from (or null if not propagated).
String	getClassificationTypeDescription() Return the description for this element's type.
String	getClassificationTypeId() Return unique identifier for the element's type.
long	getClassificationTypeVersion() Return the version number for this element's type.
List<String>	getClassificationValidProperties() Return the list of properties that valid for this type of element.
int	hashCode() Create a hash code for this element type.
void	setClassificationOrigin(ClassificationOrigin classificationOrigin) Set up the setting for classification origin
void	setClassificationOriginGUID(String classificationOriginGUID) Set up the origin of the classification.
void	setClassificationTypeDescription(String classificationTypeDescription) Set up a short description of this element's type.
void	setClassificationTypeId(String classificationTypeId) Set up the unique identifier for the element's type.
void	setClassificationTypeVersion(long classificationTypeVersion) Set up the version number for this element's type
void	setClassificationValidProperties(List<String> classificationValidProperties) Set up the list of properties that valid for this type of element.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.governanceaction.properties.ElementControlHeader

getElementCreatedBy, getElementCreateTime, getElementLicense, getElementMaintainedBy, getElementMetadataCollectionId, getElementMetadataCollectionName, getElementOriginCategory, getElementSourceServer, getElementUpdatedBy, getElementUpdateTime, getElementVersion, getHeaderVersion, getMappingProperties, getStatus, setElementCreatedBy, setElementCreateTime, setElementLicense, setElementMaintainedBy, setElementMetadataCollectionId, setElementMetadataCollectionName, setElementOriginCategory, setElementSourceServer, setElementUpdatedBy, setElementUpdateTime, setElementVersion, setHeaderVersion, setMappingProperties, setStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementClassificationHeader

public ElementClassificationHeader()

Default constructor

ElementClassificationHeader

public ElementClassificationHeader(ElementClassificationHeader template)

Copy/clone constructor

Parameters:

template - template to copy

Method Detail

setClassificationTypeId

public void setClassificationTypeId(String classificationTypeId)

Set up the unique identifier for the element's type.

Parameters:

classificationTypeId - String identifier

getClassificationTypeId

public String getClassificationTypeId()

Return unique identifier for the element's type.

Returns:

element type id

setClassificationTypeVersion

public void setClassificationTypeVersion(long classificationTypeVersion)

Set up the version number for this element's type

Parameters:

classificationTypeVersion - version number for the element type.

getClassificationTypeVersion

public long getClassificationTypeVersion()

Return the version number for this element's type.

Returns:

elementTypeVersion version number for the element type.

setClassificationTypeDescription

public void setClassificationTypeDescription(String classificationTypeDescription)

Set up a short description of this element's type.

Parameters:

classificationTypeDescription - set up the description for this element's type

getClassificationTypeDescription

public String getClassificationTypeDescription()

Return the description for this element's type.

Returns:

elementTypeDescription String description for the element type

getClassificationOrigin

public ClassificationOrigin getClassificationOrigin()

Return whether the classification was added explicitly to this asset or propagated from another entity.

Returns:

classification origin enum

setClassificationOrigin

public void setClassificationOrigin(ClassificationOrigin classificationOrigin)

Set up the setting for classification origin

Parameters:

classificationOrigin - enum

getClassificationOriginGUID

public String getClassificationOriginGUID()

Return the entity guid that the classification was propagated from (or null if not propagated).

Returns:

string guid

setClassificationOriginGUID

public void setClassificationOriginGUID(String classificationOriginGUID)

Set up the origin of the classification.

Parameters:

classificationOriginGUID - string guid

setClassificationValidProperties

public void setClassificationValidProperties(List<String> classificationValidProperties)

Set up the list of properties that valid for this type of element. Most properties are optional so if a property does not appear in its base properties then it is not set in the open metadata store.

Parameters:

classificationValidProperties - list of property names

getClassificationValidProperties

public List<String> getClassificationValidProperties()

Return the list of properties that valid for this type of element. Most properties are optional so if a property does not appear in its base properties then it is not set in the open metadata store.

Returns:

list of property names

toString

public String toString()

Standard toString method.

Overrides:

toString in class ElementControlHeader

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:

equals in class ElementControlHeader

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Create a hash code for this element type.

Overrides:

hashCode in class ElementControlHeader

Returns:

int hash code