org.vectomatic.common.rpc
Interface IDrawingService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

public interface IDrawingService
extends com.google.gwt.user.client.rpc.RemoteService

Service interface to manage drawings

Author:

Lukas Laag

Method Summary

void	deleteDrawings(String jsessionid, String[] drawingids) Deletes drawings
Drawing	duplicateDrawing(String jsessionid, String drawingid, String newName) Duplicates a drawing
Drawing[]	getDrawings(String jsessionid) Returns all the drawings owned by the session
Drawing	newDrawing(String jsessionid, String name) Creates a new drawing
void	publishDrawing(String jsessionid, String drawingid, boolean published) Publishes / unpublishes a drawing
void	renameDrawing(String jsessionid, String drawingid, String newName) Renames a drawing

Method Detail

getDrawings

Drawing[] getDrawings(String jsessionid)
                      throws AccountServiceException

Returns all the drawings owned by the session

Parameters:

jsessionid - The session id

Returns:

All the drawings owned by the session

Throws:

AccountServiceException - If a session related error occurs

InternalServerException - If the server code fails

newDrawing

Drawing newDrawing(String jsessionid,
                   String name)
                   throws AccountServiceException,
                          DrawingServiceException

Creates a new drawing

Parameters:

jsessionid - The session id

name - The drawing name (usually: "Untitled")

Returns:

A new drawing

Throws:

AccountServiceException - If a session related error occurs

InternalServerException - If the server code fails

DrawingServiceException - If the server quota is exceeded

renameDrawing

void renameDrawing(String jsessionid,
                   String drawingid,
                   String newName)
                   throws AccountServiceException,
                          DrawingServiceException

Renames a drawing

Parameters:

jsessionid - The session id

drawingid - The drawing id

newName - The drawing new name

Throws:

AccountServiceException - If a session related error occurs

InternalServerException - If the server code fails

DrawingServiceException - If the drawing no longer exists

deleteDrawings

void deleteDrawings(String jsessionid,
                    String[] drawingids)
                    throws AccountServiceException

Deletes drawings

Parameters:

jsessionid - The session id

drawingids - An array of drawing ids. Invalid drawing ids are ignored

Throws:

AccountServiceException - If a session related error occurs

InternalServerException - If the server code fails

duplicateDrawing

Drawing duplicateDrawing(String jsessionid,
                         String drawingid,
                         String newName)
                         throws AccountServiceException,
                                DrawingServiceException

Duplicates a drawing

Parameters:

jsessionid - The session id

drawingid - The drawing id

newName - The duplicate name (usually: "Copy of")

Returns:

The drawing duplicate.

Throws:

AccountServiceException - If a session related error occurs

InternalServerException - If the server code fails

DrawingServiceException - If the drawing no longer exists or the server quota has been exceeded

publishDrawing

void publishDrawing(String jsessionid,
                    String drawingid,
                    boolean published)
                    throws AccountServiceException,
                           DrawingServiceException

Publishes / unpublishes a drawing

Parameters:

jsessionid - The session id

drawingid - The drawing id

boolean - true to publish the drawing, false to unpublish it

Throws:

AccountServiceException - If a session related error occurs

InternalServerException - If the server code fails

DrawingServiceException - If the drawing no longer exists