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

Class CommentElement

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommentElement()
    Default constructor
    CommentElement(CommentElement 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.openmetadata.metadataelements.RelatedElement>
    getAcceptedAnswers()
    Return details of any comment that provides an accepted answer to the question posed in this comment.
    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 comment.
    org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.CommentProperties
    getProperties()
    Return the properties of the comment.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement>
    getQuestionsAnswered()
    Return details of any comment that poses a question that this comment answers.
    int
    hashCode()
    Return hash code for this object
    void
    setAcceptedAnswers(List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> acceptedAnswers)
    Set up details of any comment that provides an accepted answer to the question posed in this comment.
    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 comment.
    void
    setProperties(org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.CommentProperties properties)
    Set up the properties of the comment.
    void
    setQuestionsAnswered(List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> questionsAnswered)
    Set up details of any comment that poses a question that this comment answers.
    String
    toString()
    JSON-style toString

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • CommentElement

      public CommentElement()
      Default constructor

    • CommentElement

      public CommentElement(CommentElement 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.CommentProperties getProperties()
      Return the properties of the comment.
      Returns:
      properties bean

    • setProperties

      public void setProperties(org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.CommentProperties properties)
      Set up the properties of the comment.
      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 comment. This value is null if the comment was retrieved independently of any commented 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 comment. This value is null if the comment was retrieved independently of any commented element.
      Parameters:
      feedbackTargetElement - associated relationship

    • getAcceptedAnswers

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getAcceptedAnswers()
      Return details of any comment that provides an accepted answer to the question posed in this comment.
      Returns:
      list of comment headers

    • setAcceptedAnswers

      public void setAcceptedAnswers(List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> acceptedAnswers)
      Set up details of any comment that provides an accepted answer to the question posed in this comment.
      Parameters:
      acceptedAnswers - list of comment headers

    • getQuestionsAnswered

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getQuestionsAnswered()
      Return details of any comment that poses a question that this comment answers.
      Returns:
      list of comment headers

    • setQuestionsAnswered

      public void setQuestionsAnswered(List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> questionsAnswered)
      Set up details of any comment that poses a question that this comment answers.
      Parameters:
      questionsAnswered - list of comment headers

    • 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