com.communote.plugins.api.rest.v30.resource.note.favorite

Class FavoriteResourceHandler

java.lang.Object

com.communote.plugins.api.rest.v30.resource.AbstractResourceHandler<C,E,D,G,L>

com.communote.plugins.api.rest.v30.resource.DefaultResourceHandler<CreateFavoriteParameter,DefaultParameter,DeleteFavoriteParameter,DefaultParameter,GetCollectionFavoriteParameter>

com.communote.plugins.api.rest.v30.resource.note.favorite.FavoriteResourceHandler

public class FavoriteResourceHandler
extends DefaultResourceHandler<CreateFavoriteParameter,DefaultParameter,DeleteFavoriteParameter,DefaultParameter,GetCollectionFavoriteParameter>

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
FavoriteResourceHandler()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	handleCreateInternally(CreateFavoriteParameter createFavoriteParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) Request to set note as favorite
javax.ws.rs.core.Response	handleDeleteInternally(DeleteFavoriteParameter deleteFavoriteParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) Request to delete note as favorite
javax.ws.rs.core.Response	handleListInternally(GetCollectionFavoriteParameter getCollectionFavoriteParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) Request to list that a note is favorite oder not

Methods inherited from class com.communote.plugins.api.rest.v30.resource.DefaultResourceHandler

handleEditInternally, handleGetInternally

Methods inherited from class com.communote.plugins.api.rest.v30.resource.AbstractResourceHandler

handleCreate, handleDelete, handleEdit, handleGet, handleList, setValidator

Methods inherited from class java.lang.Object

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

Constructor Detail

FavoriteResourceHandler

public FavoriteResourceHandler()

Method Detail

handleCreateInternally

public javax.ws.rs.core.Response handleCreateInternally(CreateFavoriteParameter createFavoriteParameter,
                                                        String requestedMimeType,
                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                        String requestSessionId,
                                                        javax.ws.rs.core.Request request)
                                                 throws NoteNotFoundException,
                                                        ResponseBuildException,
                                                        ExtensionNotSupportedException

Request to set note as favorite

Overrides:

handleCreateInternally in class DefaultResourceHandler<CreateFavoriteParameter,DefaultParameter,DeleteFavoriteParameter,DefaultParameter,GetCollectionFavoriteParameter>

Parameters:

createFavoriteParameter - - an object that contains all the parameter that can or have to be used for such a request

requestedMimeType - - is the mime type that indicates which data exchange format to use

uriInfo - - this object is created by the request and contains some request specific data

requestSessionId - - The sessionId for the session

request - - javax request

Returns:

FavoriteResource

Throws:

NoteNotFoundException - note was not found to favorize

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

handleDeleteInternally

public javax.ws.rs.core.Response handleDeleteInternally(DeleteFavoriteParameter deleteFavoriteParameter,
                                                        String requestedMimeType,
                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                        String requestSessionId,
                                                        javax.ws.rs.core.Request request)
                                                 throws NoteNotFoundException,
                                                        ResponseBuildException,
                                                        ExtensionNotSupportedException

Request to delete note as favorite

Overrides:

handleDeleteInternally in class DefaultResourceHandler<CreateFavoriteParameter,DefaultParameter,DeleteFavoriteParameter,DefaultParameter,GetCollectionFavoriteParameter>

Parameters:

deleteFavoriteParameter - - an object that contains all the parameter that can or have to be used for such a request

requestedMimeType - - is the mime type that indicates which data exchange format to use

uriInfo - - this object is created by the request and contains some request specific data

requestSessionId - - The sessionId for the session

request - - javax request

Returns:

FavoriteResource

Throws:

NoteNotFoundException - note was not found to favorize

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

handleListInternally

public javax.ws.rs.core.Response handleListInternally(GetCollectionFavoriteParameter getCollectionFavoriteParameter,
                                                      String requestedMimeType,
                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                      String requestSessionId,
                                                      javax.ws.rs.core.Request request)
                                               throws ResponseBuildException,
                                                      ExtensionNotSupportedException

Request to list that a note is favorite oder not

Overrides:

handleListInternally in class DefaultResourceHandler<CreateFavoriteParameter,DefaultParameter,DeleteFavoriteParameter,DefaultParameter,GetCollectionFavoriteParameter>

Parameters:

getCollectionFavoriteParameter - - an object that contains all the parameter that can or have to be used for such a request

requestedMimeType - - is the mime type that indicates which data exchange format to use

uriInfo - - this object is created by the request and contains some request specific data

requestSessionId - - The sessionId for the session

request - - javax request

Returns:

FavoriteResource

Throws:

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported