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

Class NoteLogResponse

  • All Implemented Interfaces:
    Serializable, 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:
    Serialized Form

    • Constructor Detail

      • NoteLogResponse

        public NoteLogResponse()
        Default constructor

      • NoteLogResponse

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

    • Method Detail

      • getNoteLog

        public NoteLogHeader getNoteLog()
        Return the note log properties.
        Returns:
        note log bean

      • setNoteLog

        public void setNoteLog​(NoteLogHeader noteLog)
        Set up the not log properties.
        Parameters:
        noteLog - bean

      • getNotes

        public List<Note> getNotes()
        Return the notes in the note log.
        Returns:
        list of notes

      • setNotes

        public void setNotes​(List<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 FFDCResponseBase
        Parameters:
        objectToCompare - test object
        Returns:
        result of comparison

      • hashCode

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