Package com.priint.pubserver.plannerapi.interfaces

Interface NotesServiceLocal

public interface NotesServiceLocal

Local interface for the Notes service from the Planner API

Method Summary

Modifier and Type	Method	Description
Note	addNote(java.lang.String documentId, Note note)	Adds a new note to the specified document
java.util.List<Note>	addNotes(java.lang.String documentId, java.util.List<Note> notes)	Adds new notes to the specified document
java.lang.String	deleteNote(java.lang.String documentId, Note note)	Deletes note from the specified document
Note	getNoteById(java.lang.String documentId, java.lang.String noteId)	Returns the note at the specified ID belonging to the specified document
java.util.List<Note>	getNotes(NotesFilter filter)	Returns notes fulfilling the search criteria
java.util.List<Note>	getNotesByDocumentId(java.lang.String documentId, NotesFilter filter)	Returns all notes belonging to the specified document and fulfilling the search criteria
Note	setNote(java.lang.String documentId, Note note)	Modifies existing note in the specified document
java.util.List<Note>	setNotes(java.lang.String documentId, java.util.List<Note> notes)	Sets notes for the specified document

Method Detail

getNotesByDocumentId

java.util.List<Note> getNotesByDocumentId(java.lang.String documentId,
                                          NotesFilter filter)
                                   throws ServiceException,
                                          ResourceNotFoundException

Returns all notes belonging to the specified document and fulfilling the search criteria

Parameters:

documentId - document ID

filter - search criteria in the NotesFilter object

Returns:

the list of notes

Throws:

ServiceException

ResourceNotFoundException

See Also:

Note, NotesFilter

getNoteById

Note getNoteById(java.lang.String documentId,
                 java.lang.String noteId)
          throws ServiceException,
                 ResourceNotFoundException

Returns the note at the specified ID belonging to the specified document

Parameters:

documentId - document ID

noteId - note ID

Returns:

the note

Throws:

ServiceException

ResourceNotFoundException

See Also:

Note

getNotes

java.util.List<Note> getNotes(NotesFilter filter)
                       throws ServiceException

Returns notes fulfilling the search criteria

Parameters:

filter - search criteria in NotesFilter object

Returns:

the list of notes

Throws:

ServiceException

See Also:

Note, NotesFilter

setNotes

java.util.List<Note> setNotes(java.lang.String documentId,
                              java.util.List<Note> notes)
                       throws ServiceException

Sets notes for the specified document

Parameters:

documentId - document ID

notes - the list of notes to set for the document

Returns:

the list of processed notes. Each Note from the list contains status code of the operation

Throws:

ServiceException

See Also:

Note

addNotes

java.util.List<Note> addNotes(java.lang.String documentId,
                              java.util.List<Note> notes)
                       throws ServiceException

Adds new notes to the specified document

Parameters:

documentId - document ID

notes - the list of notes to add

Returns:

the list of processed notes. Each Note from the list contains status code of the operation and new ID

Throws:

ServiceException

See Also:

Note

addNote

Note addNote(java.lang.String documentId,
             Note note)
      throws ServiceException

Adds a new note to the specified document

Parameters:

documentId - document ID

note - the note to add

Returns:

the created note

Throws:

ServiceException

See Also:

Note

setNote

Note setNote(java.lang.String documentId,
             Note note)
      throws ServiceException

Modifies existing note in the specified document

Parameters:

documentId - document ID

note - the note to change

Returns:

changed note

Throws:

ServiceException

See Also:

Note

deleteNote

java.lang.String deleteNote(java.lang.String documentId,
                            Note note)
                     throws ServiceException

Deletes note from the specified document

Parameters:

documentId - document ID

note - the note to delete.

Returns:

ID of deleted note

Throws:

ServiceException

See Also:

Note