Class RelatedMetadataElement
- java.lang.Object
-
- org.odpi.openmetadata.frameworks.governanceaction.properties.ElementControlHeader
-
- org.odpi.openmetadata.frameworks.governanceaction.properties.RelatedMetadataElement
-
- All Implemented Interfaces:
Serializable
public class RelatedMetadataElement extends ElementControlHeader
This property header implements any common mechanisms that all property objects need.- 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 RelatedMetadataElement()Typical ConstructorRelatedMetadataElement(RelatedMetadataElement 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object objectToCompare)Compare the values of the supplied object with those stored in the current object.DategetEffectiveFromTime()Return the date/time that this instance should start to be used (null means it can be used from creationTime).DategetEffectiveToTime()Return the date/time that this instance should no longer be used.OpenMetadataElementgetElementProperties()Return the properties of the related element.StringgetRelationshipGUID()Return the unique id for the relationship .ElementPropertiesgetRelationshipProperties()Return the properties associated with the relationship.ElementTypegetRelationshipType()Return the element type properties for this relationship object.inthashCode()Create a hash code for this element type.voidsetEffectiveFromTime(Date effectiveFromTime)Set up the date/time that this instance should start to be used (null means it can be used from creationTime).voidsetEffectiveToTime(Date effectiveToTime)Set up the date/time that this instance should no longer be used.voidsetElementProperties(OpenMetadataElement elementProperties)Set up the properties of the related element.voidsetRelationshipGUID(String guid)Set up the unique id for the relationship.voidsetRelationshipProperties(ElementProperties relationshipProperties)Set up the properties associated with the relationship.voidsetRelationshipType(ElementType relationshipType)Set up the element type properties for this relationship object.StringtoString()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
-
-
-
-
Constructor Detail
-
RelatedMetadataElement
public RelatedMetadataElement()
Typical Constructor
-
RelatedMetadataElement
public RelatedMetadataElement(RelatedMetadataElement 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
-
getElementProperties
public OpenMetadataElement getElementProperties()
Return the properties of the related element.- Returns:
- related element
-
setElementProperties
public void setElementProperties(OpenMetadataElement elementProperties)
Set up the properties of the related element.- Parameters:
elementProperties- related element
-
toString
public String toString()
Standard toString method.- Overrides:
toStringin classElementControlHeader- 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:
equalsin classElementControlHeader- Parameters:
objectToCompare- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()
Create a hash code for this element type.- Overrides:
hashCodein classElementControlHeader- Returns:
- int hash code
-
-