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

Interface SchemeService

All Superinterfaces:

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

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

The client side stub for the SchemeService Service. This service gives all needed methods to handle custom id /auto naming / auto folding configurations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SchemeService.Instance

Method Summary

Modifier and Type	Method	Description
void	delete(long templateId, String type)	Deletes a template
void	deleteSequence(long sequenceId)	Deletes the given sequence
GUIScheme	get(long templateId, String type)	Loads a given configuration from the database
GUIScheme[]	load()	Load all Custom Identifiers rules
GUISequence[]	loadSequences()	Loads the list of sequences
void	resetSequence(long sequenceId, long value)	Reset the numbering of a given sequence
void	save(GUIScheme scheme)	Creates or updates a configuration

Method Detail

delete

void delete(long templateId,
            String type)
     throws ServerException

Deletes a template

Parameters:

templateId - identifier of the template

type - type of the template

Throws:

ServerException - an error happened in the server application

save

void save(GUIScheme scheme)
   throws ServerException

Creates or updates a configuration

Parameters:

scheme - the scheme definition

Throws:

ServerException - an error happened in the server application

get

GUIScheme get(long templateId,
              String type)
       throws ServerException

Loads a given configuration from the database

Parameters:

templateId - identifier of the template

type - type of the template

Returns:

the scheme retrieved by the server application

Throws:

ServerException - an error happened in the server application

load

GUIScheme[] load()
          throws ServerException

Load all Custom Identifiers rules

Returns:

the scheme definitions

Throws:

ServerException - an error happened in the server application

resetSequence

void resetSequence(long sequenceId,
                   long value)
            throws ServerException

Reset the numbering of a given sequence

Parameters:

sequenceId - identifier of the sequence

value - the new sequence's value

Throws:

ServerException - an error happened in the server application

loadSequences

GUISequence[] loadSequences()
                     throws ServerException

Loads the list of sequences

Returns:

all the sequences

Throws:

ServerException - an error happened in the server application

deleteSequence

void deleteSequence(long sequenceId)
             throws ServerException

Deletes the given sequence

Parameters:

sequenceId - identifiers

Throws:

ServerException - an error happened in the server application