Package org.odpi.openmetadata.accessservices.assetmanager.metadataelements

Class NoteElement

java.lang.Object
org.odpi.openmetadata.accessservices.assetmanager.metadataelements.NoteElement
All Implemented Interfaces:
CorrelatedMetadataElement
public class NoteElement extends Object implements CorrelatedMetadataElement
NoteElement contains the properties and header for a Note entity retrieved from the metadata repository.

  • Constructor Summary

    Constructors
    Constructor
    Description
    NoteElement()
    Default constructor
    NoteElement(NoteElement template)
    Copy/clone constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Return comparison result based on the content of the properties.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationHeader>
    getCorrelationHeaders()
    Return the details of the external identifier and other correlation properties about the metadata source.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader
    getElementHeader()
    Return the element header associated with the properties.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.FeedbackTargetElement
    getFeedbackTargetElement()
    Return details of the relationship from the element in the request to the note.
    Date
    getLastUpdate()
    Return the last time a change was made to this note.
    org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.NoteProperties
    getProperties()
    Return the properties of the note.
    String
    getUser()
    Return the user id of the person who created the note.
    int
    hashCode()
    Return hash code for this object
    void
    setCorrelationHeaders(List<org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationHeader> correlationHeaders)
    Set up the details of the external identifier and other correlation properties about the metadata source.
    void
    setElementHeader(org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader elementHeader)
    Set up the element header associated with the properties.
    void
    setFeedbackTargetElement(org.odpi.openmetadata.frameworks.openmetadata.metadataelements.FeedbackTargetElement feedbackTargetElement)
    Set up details of the relationship from the element in the request to the note.
    void
    setLastUpdate(Date lastUpdate)
    Set up the last time a change was made to this note.
    void
    setProperties(org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.NoteProperties properties)
    Set up the properties of the note.
    void
    setUser(String user)
    Set up the user id of the person who created the note.
    String
    toString()
    JSON-style toString

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • NoteElement

      public NoteElement()
      Default constructor

    • NoteElement

      public NoteElement(NoteElement template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getElementHeader

      public org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader getElementHeader()
      Return the element header associated with the properties.
      Specified by:
      getElementHeader in interface CorrelatedMetadataElement
      Returns:
      element header object

    • setElementHeader

      public void setElementHeader(org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader elementHeader)
      Set up the element header associated with the properties.
      Specified by:
      setElementHeader in interface CorrelatedMetadataElement
      Parameters:
      elementHeader - element header object

    • getCorrelationHeaders

      public List<org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationHeader> getCorrelationHeaders()
      Return the details of the external identifier and other correlation properties about the metadata source. There is one entry in the list for each element in the third party technology that maps to the single open source element.
      Specified by:
      getCorrelationHeaders in interface CorrelatedMetadataElement
      Returns:
      list of correlation properties objects

    • setCorrelationHeaders

      public void setCorrelationHeaders(List<org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationHeader> correlationHeaders)
      Set up the details of the external identifier and other correlation properties about the metadata source. There is one entry in the list for each element in the third party technology that maps to the single open source element.
      Specified by:
      setCorrelationHeaders in interface CorrelatedMetadataElement
      Parameters:
      correlationHeaders - list of correlation properties objects

    • getProperties

      public org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.NoteProperties getProperties()
      Return the properties of the note.
      Returns:
      properties bean

    • setProperties

      public void setProperties(org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.NoteProperties properties)
      Set up the properties of the note.
      Parameters:
      properties - properties bean

    • getFeedbackTargetElement

      public org.odpi.openmetadata.frameworks.openmetadata.metadataelements.FeedbackTargetElement getFeedbackTargetElement()
      Return details of the relationship from the element in the request to the note. This value is null if the note was retrieved independently of any noted element.
      Returns:
      associated relationship

    • setFeedbackTargetElement

      public void setFeedbackTargetElement(org.odpi.openmetadata.frameworks.openmetadata.metadataelements.FeedbackTargetElement feedbackTargetElement)
      Set up details of the relationship from the element in the request to the note. This value is null if the note was retrieved independently of any noted element.
      Parameters:
      feedbackTargetElement - associated relationship

    • getLastUpdate

      public Date getLastUpdate()
      Return the last time a change was made to this note.
      Returns:
      Date last updated

    • setLastUpdate

      public void setLastUpdate(Date lastUpdate)
      Set up the last time a change was made to this note.
      Parameters:
      lastUpdate - Date last updated

    • getUser

      public String getUser()
      Return the user id of the person who created the note. Null means the user id is not known.
      Returns:
      String user making notes

    • setUser

      public void setUser(String user)
      Set up the user id of the person who created the note. Null means the user id is not known.
      Parameters:
      user - String user making notes

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Object
      Returns:
      return string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class Object
      Returns:
      int hash code