001package com.studentgui.apphelpers.dto;
002
003/**
004 * Typed payload for freeform notes pages.
005 */
006public class NotesPayload implements SessionPayload {
007    /** Database session id. */
008    public int sessionId;
009    /** The freeform notes text. */
010    public String notes;
011
012    /** No-arg constructor for Jackson. */
013    public NotesPayload() {}
014
015    /**
016     * Create a notes payload.
017     *
018    * @param sessionIdParam DB session id
019    * @param notesParam freeform notes
020     */
021    public NotesPayload(final int sessionIdParam, final String notesParam) {
022        this.sessionId = sessionIdParam;
023        this.notes = notesParam;
024    }
025
026    @Override
027    /**
028     * Return the database session id associated with this notes payload.
029     *
030     * @return numeric session id for the recorded notes entry
031     */
032
033    public int getSessionId() { return this.sessionId; }
034}