Package com.logicaldoc.gui.frontend.client.services

Interface FormService

All Superinterfaces:

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

@RemoteServiceRelativePath("form")
public interface FormService
extends com.google.gwt.user.client.rpc.RemoteService

The client side stub for the Form Service. This service gives all needed methods to handle the forms.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FormService.Instance

Method Summary

Modifier and Type	Method	Description
void	delete(long id)	Deletes a form
GUIForm	getById(long id)	Retrieves a specific form by its ID
String	getPreFilledLink(GUIForm form, String responderEmail)	Generates the pre-filled link for the web form
void	invite(GUIForm form, GUIEmail email, String locale)	Invites by email a set of recipients to fill out the given form
String	processImage()	Processes an uploaded image for being used as form header
GUIForm	save(GUIForm form)	Saves / Creates a form

Method Details

getById

GUIForm getById(long id)
         throws ServerException

Retrieves a specific form by its ID

Parameters:

id - identifier of the forms

Returns:

the form retrieved by the server application

Throws:

ServerException - an error happened in the server application

save

GUIForm save(GUIForm form)
      throws ServerException

Saves / Creates a form

Parameters:

form - the form to store

Returns:

the stored form

Throws:

ServerException - an error happened in the server application

processImage

String processImage()
             throws ServerException

Processes an uploaded image for being used as form header

Returns:

the Bass64 representation of the uploaded image

Throws:

ServerException - an error happened in the server application

delete

void delete(long id)
     throws ServerException

Deletes a form

Parameters:

id - identifier of the form to delete

Throws:

ServerException - an error happened in the server application

invite

void invite(GUIForm form,
 GUIEmail email,
 String locale)
     throws ServerException

Invites by email a set of recipients to fill out the given form

Parameters:

form - the form to notify

email - the email to send

locale - the current locale

Throws:

ServerException - an error happened in the server application

getPreFilledLink

String getPreFilledLink(GUIForm form,
 String responderEmail)
                 throws ServerException

Generates the pre-filled link for the web form

Parameters:

form - the form with the filled fields

responderEmail - the email of the responder

Returns:

the pre-filled link

Throws:

ServerException - an error happened in the server application