Package org.odpi.openmetadata.frameworks.connectors.properties.beans

Class NoteLogHeader

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
org.odpi.openmetadata.frameworks.connectors.properties.beans.NoteLogHeader
Direct Known Subclasses:
NoteLog
public class NoteLogHeader extends Referenceable
NoteLogHeader manages a list of notes for an asset

  • Field Summary

    Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

    CURRENT_AUDIT_HEADER_VERSION

  • Constructor Summary

    Constructors
    Constructor
    Description
    NoteLogHeader()
    Default constructor
    NoteLogHeader(NoteLogHeader templateNoteLog)
    Copy/clone constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Compare the values of the supplied object with those stored in the current object.
    String
    getDescription()
    Return the stored description property for the note log.
    String
    getDisplayName()
    Return the stored display name property for the note log.
    int
    hashCode()
    Hash of properties
    void
    setDescription(String description)
    Set up the stored description property for the note log.
    void
    setDisplayName(String displayName)
    Set up the stored display name property for the note log.
    String
    toString()
    Standard toString method.

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

    getAdditionalProperties, getQualifiedName, setAdditionalProperties, setQualifiedName

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase

    getExtendedProperties, setExtendedProperties

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader

    getClassifications, getGUID, setClassifications, setGUID

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

    getHeaderVersion, getOrigin, getStatus, getType, getVersions, setHeaderVersion, setOrigin, setStatus, setType, setVersions

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • NoteLogHeader

      public NoteLogHeader()
      Default constructor

    • NoteLogHeader

      public NoteLogHeader(NoteLogHeader templateNoteLog)
      Copy/clone constructor.
      Parameters:
      templateNoteLog - note log to copy

  • Method Details

    • getDisplayName

      public String getDisplayName()
      Return the stored display name property for the note log. If no display name is available then null is returned.
      Returns:
      String Name

    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the stored display name property for the note log.
      Parameters:
      displayName - - String name

    • getDescription

      public String getDescription()
      Return the stored description property for the note log. If no description is provided then null is returned.
      Returns:
      description

    • setDescription

      public void setDescription(String description)
      Set up the stored description property for the note log.
      Parameters:
      description - String text

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Referenceable
      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 Referenceable
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Hash of properties
      Overrides:
      hashCode in class Referenceable
      Returns:
      int