Class OpenMetadataRelationship
java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader
org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataRelationship
Structure for returning a relationship between two metadata elements.
-
Field Summary
Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader
CURRENT_AUDIT_HEADER_VERSION
-
Constructor Summary
ConstructorsConstructorDescriptionTypical ConstructorCopy/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 TypeMethodDescriptionboolean
Compare the values of the supplied object with those stored in the current object.Return the date/time that this instance should start to be used (null means it can be used from creationTime).Return the date/time that this instance should no longer be used.Return details of the element at end 1 of this relationship.Return details of the element at end 2 of this relationship.Return the unique identifier of the element at end 1 of the relationship.Return the unique identifier of the element at end 2 of the relationship.Return the descriptive label for end 1 of the relationship.Return the descriptive label for end 2 of the relationship.Return the unique id for the relationship .Return the properties associated with the relationship.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
setElementAtEnd1
(ElementStub elementAtEnd1) Set up details of the element at end 1 of this relationship.void
setElementAtEnd2
(ElementStub elementAtEnd2) Set up details of the element at end 2 of this relationship.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
setLabelAtEnd1
(String labelAtEnd1) Set up the descriptive label for end 1 of the relationship.void
setLabelAtEnd2
(String labelAtEnd2) Set up the descriptive label for 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.toString()
Standard toString method.Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader
getHeaderVersion, getOrigin, getStatus, getType, getVersions, setHeaderVersion, setOrigin, setStatus, setType, setVersions
-
Constructor Details
-
OpenMetadataRelationship
public OpenMetadataRelationship()Typical Constructor -
OpenMetadataRelationship
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 Details
-
getRelationshipGUID
Return the unique id for the relationship .- Returns:
- String unique id
-
setRelationshipGUID
Set up the unique id for the relationship.- Parameters:
guid
- String unique identifier
-
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
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
Return the date/time that this instance should start to be used (null means it can be used from creationTime).- Returns:
- Date object
-
setEffectiveFromTime
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
Return the date/time that this instance should no longer be used.- Returns:
- Date object
-
setEffectiveToTime
Set up the date/time that this instance should no longer be used.- Parameters:
effectiveToTime
- Date object
-
getRelationshipProperties
Return the properties associated with the relationship.- Returns:
- property names and values
-
setRelationshipProperties
Set up the properties associated with the relationship.- Parameters:
relationshipProperties
- property names and values
-
getElementGUIDAtEnd1
Return the unique identifier of the element at end 1 of the relationship.- Returns:
- related element
-
setElementGUIDAtEnd1
Set up the unique identifier of the element at end 1 of the relationship.- Parameters:
elementGUIDAtEnd1
- related element
-
getElementGUIDAtEnd2
Return the unique identifier of the element at end 2 of the relationship.- Returns:
- related element
-
setElementGUIDAtEnd2
Set up the unique identifier of the element at end 2 of the relationship.- Parameters:
elementGUIDAtEnd2
- related element
-
getLabelAtEnd1
Return the descriptive label for end 1 of the relationship.- Returns:
- string name
-
setLabelAtEnd1
Set up the descriptive label for end 1 of the relationship.- Parameters:
labelAtEnd1
- string name
-
getLabelAtEnd2
Return the descriptive label for end 2 of the relationship.- Returns:
- string name
-
setLabelAtEnd2
Set up the descriptive label for end 2 of the relationship.- Parameters:
labelAtEnd2
- string name
-
getElementAtEnd1
Return details of the element at end 1 of this relationship.- Returns:
- element stub
-
setElementAtEnd1
Set up details of the element at end 1 of this relationship.- Parameters:
elementAtEnd1
- element stub
-
getElementAtEnd2
Return details of the element at end 2 of this relationship.- Returns:
- element stub
-
setElementAtEnd2
Set up details of the element at end 2 of this relationship.- Parameters:
elementAtEnd2
- element stub
-
toString
Standard toString method.- Overrides:
toString
in classElementControlHeader
- Returns:
- print out of variables in a JSON-style
-
equals
Compare the values of the supplied object with those stored in the current object.- Overrides:
equals
in classElementControlHeader
- Parameters:
objectToCompare
- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Create a hash code for this element type.- Overrides:
hashCode
in classElementControlHeader
- Returns:
- int hash code
-