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
void	delete(long templateId)	Deletes a given template
GUIBarcodeTemplate	getTemplate(long templateId)	Loads a given template from the database
void	markUnprocessable(long[] ids)	Marks a set of documents as not processable
GUIDocument	process(long docId)	Processes the given document
void	rescheduleAll()	Reschedule all documents for processing
GUIBarcodeTemplate	save(GUIBarcodeTemplate template)	Creates or updates a template
GUIBarcodeSpec	updateZone(GUIBarcodeSpec zone)	Updates a single zone, if the zone does not exist it will be created

Method Detail

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

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

GUIBarcodeTemplate save(GUIBarcodeTemplate 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

GUIBarcodeTemplate 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

process

GUIDocument process(long docId)
             throws ServerException

Processes the given document

Parameters:

docId - identifier of the document to process

Returns:

the processed document's representation

Throws:

ServerException - an error happened during the barcode processing

updateZone

GUIBarcodeSpec updateZone(GUIBarcodeSpec zone)
                   throws ServerException

Updates a single zone, if the zone does not exist it will be created

Parameters:

zone - the zone to update

Returns:

the newly added zone

Throws:

ServerException - an error happened in the server application