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

Interface BarcodeService

All Superinterfaces:

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

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

The client side stub for the Barcode Engine Service.

Since:

6.1

Author:

Marco Meschieri - LogicalDOC

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BarcodeService.Instance

Method Summary

Modifier and Type	Method	Description
GUIBarcodeEngine	getInfo()	Loads a bean that contains all engine informations
GUIBarcodePattern[]	loadPatterns(Long templateId)	Loads the patterns configured for a given template
void	markUnprocessable(long[] ids)	Marks a set of documents as not processable
void	rescheduleAll()	Reschedule all documents for processing
void	save(GUIBarcodeEngine engine)	Saves the engine settings
void	savePatterns(GUIBarcodePattern[] patterns, Long templateId)	Saves the patterns for the given template ordered by position

Method Detail

getInfo

GUIBarcodeEngine getInfo()
                  throws ServerException

Loads a bean that contains all engine informations

Returns:

the barcode engine descriptor

Throws:

ServerException - an error happened in the server application

save

void save(GUIBarcodeEngine engine)
   throws ServerException

Saves the engine settings

Parameters:

engine - the settings to save

Throws:

ServerException - an error happened in the server application

rescheduleAll

void rescheduleAll()
            throws ServerException

Reschedule all documents for processing

Throws:

ServerException - an error happened in the server application

markUnprocessable

void markUnprocessable(long[] ids)
                throws ServerException

Marks a set of documents as not processable

Parameters:

ids - document identifiers

Throws:

ServerException - an error happened in the server application

loadPatterns

GUIBarcodePattern[] loadPatterns(Long templateId)
                          throws ServerException

Loads the patterns configured for a given template

Parameters:

templateId - identifier of the template

Returns:

the patterns assigned to the given template

Throws:

ServerException - an error happened in the server application

savePatterns

void savePatterns(GUIBarcodePattern[] patterns,
                  Long templateId)
           throws ServerException

Saves the patterns for the given template ordered by position

Parameters:

patterns - the recognition patterns

templateId - identifier of the template

Throws:

ServerException - an error happened in the server application