Package org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.rest

Class NoteLogResponse

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.rest.OCFOMASAPIResponse
org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.rest.NoteLogResponse
All Implemented Interfaces:
Serializable, org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponse
public class NoteLogResponse extends OCFOMASAPIResponse
NoteLogResponse is the response structure used on the OMAS REST API calls that returns a NoteLogHeader object as a response. It returns details of the note log, the first few notes and the total count of the notes within it.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    NoteLogResponse()
    Default constructor
    NoteLogResponse(NoteLogResponse 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.
    int
    getNoteCount()
    Return the count of the notes within the note log.
    org.odpi.openmetadata.frameworks.connectors.properties.beans.NoteLogHeader
    getNoteLog()
    Return the note log properties.
    List<org.odpi.openmetadata.frameworks.connectors.properties.beans.Note>
    getNotes()
    Return the notes in the note log.
    int
    hashCode()
    Return hash code for this object
    void
    setNoteCount(int noteCount)
    Set up the count of notes within the note log.
    void
    setNoteLog(org.odpi.openmetadata.frameworks.connectors.properties.beans.NoteLogHeader noteLog)
    Set up the not log properties.
    void
    setNotes(List<org.odpi.openmetadata.frameworks.connectors.properties.beans.Note> notes)
    Set up the list of notes from the note log.
    String
    toString()
    JSON-style toString

    Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

    getActionDescription, getExceptionCausedBy, getExceptionClassName, getExceptionErrorMessage, getExceptionErrorMessageId, getExceptionErrorMessageParameters, getExceptionProperties, getExceptionSystemAction, getExceptionUserAction, getRelatedHTTPCode, setActionDescription, setExceptionCausedBy, setExceptionClassName, setExceptionErrorMessage, setExceptionErrorMessageId, setExceptionErrorMessageParameters, setExceptionProperties, setExceptionSystemAction, setExceptionUserAction, setRelatedHTTPCode

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • NoteLogResponse

      public NoteLogResponse()
      Default constructor

    • NoteLogResponse

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

  • Method Details

    • getNoteLog

      public org.odpi.openmetadata.frameworks.connectors.properties.beans.NoteLogHeader getNoteLog()
      Return the note log properties.
      Returns:
      note log bean

    • setNoteLog

      public void setNoteLog(org.odpi.openmetadata.frameworks.connectors.properties.beans.NoteLogHeader noteLog)
      Set up the not log properties.
      Parameters:
      noteLog - bean

    • getNotes

      public List<org.odpi.openmetadata.frameworks.connectors.properties.beans.Note> getNotes()
      Return the notes in the note log.
      Returns:
      list of notes

    • setNotes

      public void setNotes(List<org.odpi.openmetadata.frameworks.connectors.properties.beans.Note> notes)
      Set up the list of notes from the note log. If there are too many notes to return on a single call, the starting element number for the notes returned in this response are
      Parameters:
      notes - list of notes

    • getNoteCount

      public int getNoteCount()
      Return the count of the notes within the note log.
      Returns:
      int

    • setNoteCount

      public void setNoteCount(int noteCount)
      Set up the count of notes within the note log.
      Parameters:
      noteCount - int

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class OCFOMASAPIResponse
      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 org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
      Returns:
      int hash code