Package com.priint.pubserverapi.note

Interface NoteServiceLocal

public interface NoteServiceLocal

Local interface for managing notes.

This service provides methods for creating, retrieving, updating, and deleting notes.

All operations may throw NoteServiceException if an error occurs during processing.

Method Summary

Modifier and Type	Method	Description
NoteId	create(DocumentId documentId, Note note)	Creates a new note for the specific document
NoteQuery	createNoteQuery(DocumentId documentId)	Creates a new NoteQuery for querying notes.
void	delete(DocumentId documentId, NoteId noteId)	Deletes an existing note for the specific document
Optional<Note>	getNoteById(DocumentId documentId, NoteId noteId)	Retrieves a Note by document id and note id
void	update(DocumentId documentId, Note note)	Updates an existing note for the specific document
void	update(DocumentId documentId, List<Note> notes)	Updates existing notes for the specific document

Method Details

createNoteQuery

NoteQuery createNoteQuery(DocumentId documentId)

Creates a new NoteQuery for querying notes.

Parameters:

documentId - document id *

Returns:

a new NoteQuery instance

getNoteById

Optional<Note> getNoteById(DocumentId documentId,
 NoteId noteId)

Retrieves a Note by document id and note id

Parameters:

documentId - document id

noteId - note id

Returns:

an Optional containing the note if found, or empty if not

create

NoteId create(DocumentId documentId,
 Note note)
       throws NoteServiceException

Creates a new note for the specific document

Parameters:

documentId - document id

note - the note to create

Returns:

note id

Throws:

NoteServiceException

update

void update(DocumentId documentId,
 Note note)
     throws NoteServiceException

Updates an existing note for the specific document

Parameters:

documentId - document id

note - the note to update

Throws:

NoteServiceException

update

void update(DocumentId documentId,
 List<Note> notes)
     throws NoteServiceException

Updates existing notes for the specific document

Parameters:

documentId - document id

notes - list of the notes to update

Throws:

NoteServiceException

delete

void delete(DocumentId documentId,
 NoteId noteId)
     throws NoteServiceException

Deletes an existing note for the specific document

Parameters:

documentId - document id

noteId - note id

Throws:

NoteServiceException