Package org.exoplatform.wiki.service.rest

Class NotesRestService

java.lang.Object

org.exoplatform.wiki.service.rest.NotesRestService

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

@RolesAllowed("users")
public class NotesRestService
extends Object
implements org.exoplatform.services.rest.resource.ResourceContainer

Constructor Summary

Constructors

Constructor	Description
NotesRestService(NoteService noteService, WikiService noteBookService, org.exoplatform.upload.UploadService uploadService, org.exoplatform.services.resources.ResourceBundleService resourceBundleService, NotesExportService notesExportService)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	cancelExportNote(int exportId)
javax.ws.rs.core.Response	createNote(Page note)
javax.ws.rs.core.Response	deleteDraftNote(String noteId)
javax.ws.rs.core.Response	deleteNote(String noteBookType, String noteBookOwner, String noteId)
javax.ws.rs.core.Response	deleteNoteById(String noteId)
javax.ws.rs.core.Response	exportNote(String notesList, int exportId, Boolean exportAll)
javax.ws.rs.core.Response	getDraftNoteById(String noteId)
javax.ws.rs.core.Response	getExportedZip(int exportId)
javax.ws.rs.core.Response	getExportNoteStatus(int exportId)
javax.ws.rs.core.Response	getFullTreeData(String path, Boolean withDrafts)
javax.ws.rs.core.Response	getLatestDraftOfPage(String noteId)
javax.ws.rs.core.Response	getNote(String noteBookType, String noteBookOwner, String noteId, String source)
javax.ws.rs.core.Response	getNoteById(String noteId, String noteBookType, String noteBookOwner, boolean withChildren, String source)
javax.ws.rs.core.Response	getNoteVersions(String noteId)
javax.ws.rs.core.Response	getTreeData(String type, String path, String currentPath, Boolean canEdit, Boolean showExcerpt, String depth)
javax.ws.rs.core.Response	importNote(String noteId, String uploadId, String conflict)
javax.ws.rs.core.Response	moveNote(String noteId, String toNoteId)
javax.ws.rs.core.Response	RestoreNoteVersion(String noteVersion, Page note)
javax.ws.rs.core.Response	saveDraft(DraftPage draftNoteToSave)
javax.ws.rs.core.Response	searchData(javax.ws.rs.core.UriInfo uriInfo, String keyword, int limit, String wikiType, String wikiOwner, boolean favorites)	Return a list of title based on a searched words.
javax.ws.rs.core.Response	updateNote(String noteBookType, String noteBookOwner, String noteId, Page note)
javax.ws.rs.core.Response	updateNoteById(String noteId, Page note)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NotesRestService

public NotesRestService(NoteService noteService,
 WikiService noteBookService,
 org.exoplatform.upload.UploadService uploadService,
 org.exoplatform.services.resources.ResourceBundleService resourceBundleService,
 NotesExportService notesExportService)

Method Details

getNote

@RolesAllowed("users")
public javax.ws.rs.core.Response getNote(String noteBookType,
 String noteBookOwner,
 String noteId,
 String source)

getNoteById

@RolesAllowed("users")
public javax.ws.rs.core.Response getNoteById(String noteId,
 String noteBookType,
 String noteBookOwner,
 boolean withChildren,
 String source)

getDraftNoteById

@RolesAllowed("users")
public javax.ws.rs.core.Response getDraftNoteById(String noteId)

getLatestDraftOfPage

@RolesAllowed("users")
public javax.ws.rs.core.Response getLatestDraftOfPage(String noteId)

getNoteVersions

@RolesAllowed("users")
public javax.ws.rs.core.Response getNoteVersions(String noteId)

createNote

@RolesAllowed("users")
public javax.ws.rs.core.Response createNote(Page note)

saveDraft

@RolesAllowed("users")
public javax.ws.rs.core.Response saveDraft(DraftPage draftNoteToSave)

updateNote

@RolesAllowed("users")
public javax.ws.rs.core.Response updateNote(String noteBookType,
 String noteBookOwner,
 String noteId,
 Page note)

updateNoteById

@RolesAllowed("users")
public javax.ws.rs.core.Response updateNoteById(String noteId,
 Page note)

RestoreNoteVersion

@RolesAllowed("users")
public javax.ws.rs.core.Response RestoreNoteVersion(String noteVersion,
 Page note)

deleteNote

@RolesAllowed("users")
public javax.ws.rs.core.Response deleteNote(String noteBookType,
 String noteBookOwner,
 String noteId)

deleteNoteById

@RolesAllowed("users")
public javax.ws.rs.core.Response deleteNoteById(String noteId)

deleteDraftNote

@RolesAllowed("users")
public javax.ws.rs.core.Response deleteDraftNote(String noteId)

moveNote

@RolesAllowed("users")
public javax.ws.rs.core.Response moveNote(String noteId,
 String toNoteId)

exportNote

@RolesAllowed("users")
public javax.ws.rs.core.Response exportNote(String notesList,
 int exportId,
 Boolean exportAll)

getExportedZip

@RolesAllowed("users")
public javax.ws.rs.core.Response getExportedZip(int exportId)

getExportNoteStatus

@RolesAllowed("users")
public javax.ws.rs.core.Response getExportNoteStatus(int exportId)

cancelExportNote

@RolesAllowed("users")
public javax.ws.rs.core.Response cancelExportNote(int exportId)

importNote

@RolesAllowed("users")
public javax.ws.rs.core.Response importNote(String noteId,
 String uploadId,
 String conflict)

getTreeData

@RolesAllowed("users")
public javax.ws.rs.core.Response getTreeData(String type,
 String path,
 String currentPath,
 Boolean canEdit,
 Boolean showExcerpt,
 String depth)

getFullTreeData

@RolesAllowed("users")
public javax.ws.rs.core.Response getFullTreeData(String path,
 Boolean withDrafts)

searchData

@RolesAllowed("users")
public javax.ws.rs.core.Response searchData(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 String keyword,
 int limit,
 String wikiType,
 String wikiOwner,
 boolean favorites)
                                     throws Exception

Return a list of title based on a searched words.

Parameters:

uriInfo - uriInfo

keyword - Word to search

wikiType - It can be a Portal, Group, User type of wiki

wikiOwner - Is the owner of the wiki

Returns:

List of title

Throws:

Exception - if an error occured