Package org.odpi.openmetadata.frameworks.governanceaction.properties

Class ElementClassification

java.lang.Object

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

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

org.odpi.openmetadata.frameworks.governanceaction.properties.ElementClassification

All Implemented Interfaces:

Serializable

public class ElementClassification
extends ElementClassificationHeader

The ElementClassification bean describes a single classification associated with an element.

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	Description
ElementClassification()	Default constructor
ElementClassification(ElementClassification template)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Compare the values of the supplied object with those stored in the current object.
String	getClassificationName()	Return the name of the classification
ElementProperties	getClassificationProperties()	Return a collection of the additional stored properties for the classification.
Date	getEffectiveFromTime()	Return the date/time that this instance should start to be used (null means it can be used from creationTime).
Date	getEffectiveToTime()	Return the date/time that this instance should no longer be used.
int	hashCode()	Create a hash code for this element type.
void	setClassificationName(String classificationName)	Set up the name of the classification.
void	setClassificationProperties(ElementProperties classificationProperties)	Set up a collection of the additional stored properties for the classification.
void	setEffectiveFromTime(Date effectiveFromTime)	Set up the date/time that this instance should start to be used (null means it can be used from creationTime).
void	setEffectiveToTime(Date effectiveToTime)	Set up the date/time that this instance should no longer be used.
String	toString()	Standard toString method.

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

getClassificationOrigin, getClassificationOriginGUID, getClassificationTypeDescription, getClassificationTypeId, getClassificationTypeVersion, getClassificationValidProperties, setClassificationOrigin, setClassificationOriginGUID, setClassificationTypeDescription, setClassificationTypeId, setClassificationTypeVersion, setClassificationValidProperties

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

ElementClassification

public ElementClassification()

Default constructor

ElementClassification

public ElementClassification(ElementClassification template)

Copy/clone constructor

Parameters:

template - template to copy

Method Detail

setClassificationName

public void setClassificationName(String classificationName)

Set up the name of the classification. This name is the type name defined in a ClassificationDef type definition.

Parameters:

classificationName - name of classification

getClassificationName

public String getClassificationName()

Return the name of the classification

Returns:

String name

getEffectiveFromTime

public Date getEffectiveFromTime()

Return the date/time that this instance should start to be used (null means it can be used from creationTime).

Returns:

Date object

setEffectiveFromTime

public void setEffectiveFromTime(Date effectiveFromTime)

Set up the date/time that this instance should start to be used (null means it can be used from creationTime).

Parameters:

effectiveFromTime - Date object

getEffectiveToTime

public Date getEffectiveToTime()

Return the date/time that this instance should no longer be used.

Returns:

Date object

setEffectiveToTime

public void setEffectiveToTime(Date effectiveToTime)

Set up the date/time that this instance should no longer be used.

Parameters:

effectiveToTime - Date object

setClassificationProperties

public void setClassificationProperties(ElementProperties classificationProperties)

Set up a collection of the additional stored properties for the classification. If no stored properties are present then null is returned.

Parameters:

classificationProperties - properties for the classification

getClassificationProperties

public ElementProperties getClassificationProperties()

Return a collection of the additional stored properties for the classification. If no stored properties are present then null is returned.

Returns:

properties map

toString

public String toString()

Standard toString method.

Overrides:

toString in class ElementClassificationHeader

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 ElementClassificationHeader

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 ElementClassificationHeader

Returns:

int hash code