org.odpi.openmetadata.frameworks.governanceaction.properties

Class OpenMetadataElement

java.lang.Object

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

org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataElement

All Implemented Interfaces:

Serializable

public class OpenMetadataElement
extends ElementControlHeader

OpenMetadataElement describes an entity in an open metadata repository.

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
OpenMetadataElement() Typical Constructor
OpenMetadataElement(OpenMetadataElement template) Copy/clone Constructor the resulting object will return true if tested with this.equals(template) as long as the template object is not null;

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.
List<ElementClassification>	getClassifications() Return the list of classifications associated with the metadata element.
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.
String	getElementGUID() Return the unique id for the metadata element.
ElementProperties	getElementProperties() Return the properties that are stored with the metadata element.
ElementType	getElementType() Return the element type properties for this metadata element.
int	hashCode() Create a hash code for this element type.
void	setClassifications(List<ElementClassification> classifications) Set up the list of classifications associated with the metadata element.
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.
void	setElementGUID(String guid) Set up the unique id for the metadata element.
void	setElementProperties(ElementProperties elementProperties) Set up the properties that are stored with the metadata element.
void	setElementType(ElementType type) Set up the element type properties for this metadata 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

OpenMetadataElement

public OpenMetadataElement()

Typical Constructor

OpenMetadataElement

public OpenMetadataElement(OpenMetadataElement template)

Copy/clone Constructor the resulting object will return true if tested with this.equals(template) as long as the template object is not null;

Parameters:

template - object being copied

Method Detail

getElementGUID

public String getElementGUID()

Return the unique id for the metadata element.

Returns:

String unique identifier

setElementGUID

public void setElementGUID(String guid)

Set up the unique id for the metadata element.

Parameters:

guid - String unique identifier

getElementType

public ElementType getElementType()

Return the element type properties for this metadata element.

Returns:

ElementType type information.

setElementType

public void setElementType(ElementType type)

Set up the element type properties for this metadata element.

Parameters:

type - element type properties

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

getClassifications

public List<ElementClassification> getClassifications()

Return the list of classifications associated with the metadata element.

Returns:

Classifications list of classifications

setClassifications

public void setClassifications(List<ElementClassification> classifications)

Set up the list of classifications associated with the metadata element.

Parameters:

classifications - list of classifications

getElementProperties

public ElementProperties getElementProperties()

Return the properties that are stored with the metadata element. The ElementType includes the list of valid property names.

Returns:

property map

setElementProperties

public void setElementProperties(ElementProperties elementProperties)

Set up the properties that are stored with the metadata element. The ElementType includes the list of valid property names.

Parameters:

elementProperties - property map

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