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(Note note)	Creates a new note
NoteCommentId	createComment(NoteId noteId, NoteComment noteComment)	Creates a new comment for a note
NoteQuery	createNoteQuery()	Creates a new NoteQuery for querying notes.
void	delete(NoteId noteId)	Deletes an existing note by its id
void	delete(List<NoteId> noteId)	Deletes existing notes by their id
void	deleteComment(NoteCommentId noteCommentId)	Delete a note comment (Only the last, added by yourself).
Optional<Note>	getNoteById(NoteId noteId)	Retrieves a Note by note id
void	update(Note note)	Updates an existing note
void	update(List<Note> notes)	Updates existing notes
void	updateComment(NoteComment noteComment)	Update a note comment (Only the last, added by yourself).

Method Details

createNoteQuery

NoteQuery createNoteQuery()

Creates a new NoteQuery for querying notes.

Returns:

a new NoteQuery instance

getNoteById

Optional<Note> getNoteById(NoteId noteId)

Retrieves a Note by note id

Parameters:

noteId - note id

Returns:

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

create

NoteId create(Note note)
       throws NoteServiceException

Creates a new note

Parameters:

note - the note to create

Returns:

note id

Throws:

NoteServiceException

update

void update(Note note)
     throws NoteServiceException

Updates an existing note

Parameters:

note - the note to update

Throws:

NoteServiceException

update

void update(List<Note> notes)
     throws NoteServiceException

Updates existing notes

Parameters:

notes - list of the notes to update

Throws:

NoteServiceException

delete

void delete(NoteId noteId)
     throws NoteServiceException

Deletes an existing note by its id

Parameters:

noteId - note id

Throws:

NoteServiceException

delete

void delete(List<NoteId> noteId)
     throws NoteServiceException

Deletes existing notes by their id

Parameters:

noteId - note id

Throws:

NoteServiceException

createComment

NoteCommentId createComment(NoteId noteId,
 NoteComment noteComment)

Creates a new comment for a note

Parameters:

noteId - the note id

noteComment - a note comment to create

Returns:

note comment id

Throws:

NoteServiceException

updateComment

void updateComment(NoteComment noteComment)

Update a note comment (Only the last, added by yourself).

Parameters:

noteComment - a note comment to update

Throws:

NoteServiceException

deleteComment

void deleteComment(NoteCommentId noteCommentId)

Delete a note comment (Only the last, added by yourself).

Parameters:

noteCommentId - a note comment id

Throws:

NoteServiceException