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

Interface TemplateService

All Superinterfaces:

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

All Known Implementing Classes:

TemplateServiceImpl

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TemplateService.Instance

Method Summary

Modifier and Type	Method	Description
long	countDocuments(long templateId)	Counts the documents of a given template
void	delete(long templateId)	Deletes a given template
GUIAttribute[]	getAttributes(long templateId, GUIExtensibleObject extensibleObject)	Retrieves all attributes of the specified template
GUITemplate	getTemplate(long templateId)	Loads a given template from the database
GUITemplate	save(GUITemplate template)	Creates or updates a template

Method Detail

delete

void delete(long templateId)
     throws ServerException

Deletes a given template

Parameters:

templateId - identifier of the template

Throws:

ServerException - an error happened in the server application

save

GUITemplate save(GUITemplate template)
          throws ServerException

Creates or updates a template

Parameters:

template - the template to save

Returns:

the saved template

Throws:

ServerException - an error happened in the server application

getTemplate

GUITemplate getTemplate(long templateId)
                 throws ServerException

Loads a given template from the database

Parameters:

templateId - identifier of the template

Returns:

the template retrieved by the server application

Throws:

ServerException - an error happened in the server application

countDocuments

long countDocuments(long templateId)
             throws ServerException

Counts the documents of a given template

Parameters:

templateId - identifier of the template

Returns:

number of documents referencing the template

Throws:

ServerException - an error happened in the server application

getAttributes

GUIAttribute[] getAttributes(long templateId,
                             GUIExtensibleObject extensibleObject)
                      throws ServerException

Retrieves all attributes of the specified template

Parameters:

templateId - identifier of the template

extensibleObject - this is optional and is the object for which the attributes must be retrieved

Returns:

the attributes

Throws:

ServerException - an error happened in the server application