org.odpi.openmetadata.frameworks.governanceaction.properties

Class RelatedMetadataElements

java.lang.Object

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

org.odpi.openmetadata.frameworks.governanceaction.properties.RelatedMetadataElements

All Implemented Interfaces:

Serializable

public class RelatedMetadataElements
extends ElementControlHeader

Structure for returning a relationship between two metadata elements.

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
RelatedMetadataElements() Typical Constructor
RelatedMetadataElements(RelatedMetadataElements 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.
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	getElementGUIDAtEnd1() Return the unique identifier of the element at end 1 of the relationship.
String	getElementGUIDAtEnd2() Return the unique identifier of the element at end 2 of the relationship.
String	getRelationshipGUID() Return the unique id for the relationship .
ElementProperties	getRelationshipProperties() Return the properties associated with the relationship.
ElementType	getRelationshipType() Return the element type properties for this relationship object.
int	hashCode() Create a hash code for this element type.
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	setElementGUIDAtEnd1(String elementGUIDAtEnd1) Set up the unique identifier of the element at end 1 of the relationship.
void	setElementGUIDAtEnd2(String elementGUIDAtEnd2) Set up the unique identifier of the element at end 2 of the relationship.
void	setRelationshipGUID(String guid) Set up the unique id for the relationship.
void	setRelationshipProperties(ElementProperties relationshipProperties) Set up the properties associated with the relationship.
void	setRelationshipType(ElementType relationshipType) Set up the element type properties for this relationship object.
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

RelatedMetadataElements

public RelatedMetadataElements()

Typical Constructor

RelatedMetadataElements

public RelatedMetadataElements(RelatedMetadataElements 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

getRelationshipGUID

public String getRelationshipGUID()

Return the unique id for the relationship .

Returns:

String unique id

setRelationshipGUID

public void setRelationshipGUID(String guid)

Set up the unique id for the relationship.

Parameters:

guid - String unique identifier

getRelationshipType

public ElementType getRelationshipType()

Return the element type properties for this relationship object. These values are set up by the metadata repository and define details to the metadata relationship used to represent this element.

Returns:

element type properties

setRelationshipType

public void setRelationshipType(ElementType relationshipType)

Set up the element type properties for this relationship object. These values are set up by the metadata repository and define details to the metadata relationship used to represent this element.

Parameters:

relationshipType - 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

getRelationshipProperties

public ElementProperties getRelationshipProperties()

Return the properties associated with the relationship.

Returns:

property names and values

setRelationshipProperties

public void setRelationshipProperties(ElementProperties relationshipProperties)

Set up the properties associated with the relationship.

Parameters:

relationshipProperties - property names and values

getElementGUIDAtEnd1

public String getElementGUIDAtEnd1()

Return the unique identifier of the element at end 1 of the relationship.

Returns:

related element

setElementGUIDAtEnd1

public void setElementGUIDAtEnd1(String elementGUIDAtEnd1)

Set up the unique identifier of the element at end 1 of the relationship.

Parameters:

elementGUIDAtEnd1 - related element

getElementGUIDAtEnd2

public String getElementGUIDAtEnd2()

Return the unique identifier of the element at end 2 of the relationship.

Returns:

related element

setElementGUIDAtEnd2

public void setElementGUIDAtEnd2(String elementGUIDAtEnd2)

Set up the unique identifier of the element at end 2 of the relationship.

Parameters:

elementGUIDAtEnd2 - related element

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