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

Interface AttributeSetService

All Superinterfaces:

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

All Known Implementing Classes:

AttributeSetServiceImpl

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

The client side stub for the AttributeSet Service. This service gives all needed methods to handle attribute sets

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AttributeSetService.Instance

Method Summary

Modifier and Type	Method	Description
void	applyInitializationToTemplates(long setId, String attribute)	Forces the initialization of an attribute to all those templates that use it
void	applyValidationToTemplates(long setId, String attribute)	Forces the validation of an attribute to all those templates that use it
void	delete(long setId)	Deletes a given set
void	deleteOptions(long setId, String attribute, String[] values)	Delete a selection of options
GUIAttributeSet	getAttributeSet(long setId)	Loads a given set from the database
GUIAttributeSet[]	getAttributeSets()	Loads all the sets from the database
GUIValue[]	parseOptions(long setId, String attribute)	Reads the contacts that are about to be imported from CSV
GUIAttributeSet	save(GUIAttributeSet set)	Creates or updates a set
void	saveOptions(long setId, String attribute, GUIValue[] options)	Saves the list of all possible options

Method Detail

delete

void delete(long setId)
     throws ServerException

Deletes a given set

Parameters:

setId - identifier of the set

Throws:

ServerException - an error happened in the server application

save

GUIAttributeSet save(GUIAttributeSet set)
              throws ServerException

Creates or updates a set

Parameters:

set - the set to save

Returns:

the saved set

Throws:

ServerException - an error happened in the server application

getAttributeSet

GUIAttributeSet getAttributeSet(long setId)
                         throws ServerException

Loads a given set from the database

Parameters:

setId - identifier of the set

Returns:

the set retrieved from the server

Throws:

ServerException - an error happened in the server application

getAttributeSets

GUIAttributeSet[] getAttributeSets()
                            throws ServerException

Loads all the sets from the database

Returns:

the sets retrieved from the server

Throws:

ServerException - an error happened in the server application

saveOptions

void saveOptions(long setId,
                 String attribute,
                 GUIValue[] options)
          throws ServerException

Saves the list of all possible options

Parameters:

setId - identifier of the set

attribute - name of the attribute

options - array of possible options

Throws:

ServerException - an error happened in the server application

deleteOptions

void deleteOptions(long setId,
                   String attribute,
                   String[] values)
            throws ServerException

Delete a selection of options

Parameters:

setId - identifier of the set

attribute - name of the attribute

values - array of options to delete

Throws:

ServerException - an error happened in the server application

parseOptions

GUIValue[] parseOptions(long setId,
                        String attribute)
                 throws ServerException

Reads the contacts that are about to be imported from CSV

Parameters:

setId - identifier of the set

attribute - name of the attribute

Returns:

array of options

Throws:

ServerException - an error happened in the server application

applyValidationToTemplates

void applyValidationToTemplates(long setId,
                                String attribute)
                         throws ServerException

Forces the validation of an attribute to all those templates that use it

Parameters:

setId - identifier of the set

attribute - name of the attribute

Throws:

ServerException - an error happened in the server application

applyInitializationToTemplates

void applyInitializationToTemplates(long setId,
                                    String attribute)
                             throws ServerException

Forces the initialization of an attribute to all those templates that use it

Parameters:

setId - identifier of the set

attribute - name of the attribute

Throws:

ServerException - an error happened in the server application