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

Interface AuditService

All Superinterfaces:

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

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

The client side stub for the Audit Service. This service allows folders and documents subscription.

Since:

6.0

Author:

Marco Meschieri - LogicalDOC

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AuditService.Instance

Method Summary

Modifier and Type	Method	Description
void	deleteSubscriptions(long[] ids)	Deletes a list of Subscriptions
void	subscribeDocuments(long[] docIds, String[] events, Long userId, Long groupId)	Subscribes a selection of documents
void	subscribeFolder(long folderId, boolean currentOnly, String[] events, Long userId, Long groupId)	Subscribes a folder
void	update(long[] ids, boolean currentOnly, String[] events)	Changes a set of subscriptions

Method Detail

subscribeFolder

void subscribeFolder(long folderId,
                     boolean currentOnly,
                     String[] events,
                     Long userId,
                     Long groupId)
              throws ServerException

Subscribes a folder

Parameters:

folderId - identifier of the folder

currentOnly - if the subscription must be on the folder only(not children)

events - the events to subscribe to

userId - identifier of the user (if not specified, fill the groupId)

groupId - identifier of the group (if not specified, fill the userId)

Throws:

ServerException - error in the server application

subscribeDocuments

void subscribeDocuments(long[] docIds,
                        String[] events,
                        Long userId,
                        Long groupId)
                 throws ServerException

Subscribes a selection of documents

Parameters:

docIds - identifiers of the documents

events - the events to subscribe to

userId - identifier of the user (if not specified, fill the groupId)

groupId - identifier of the group (if not specified, fill the userId)

Throws:

ServerException - error in the server application

update

void update(long[] ids,
            boolean currentOnly,
            String[] events)
     throws ServerException

Changes a set of subscriptions

Parameters:

ids - identifiers of the subscriptions

currentOnly - if the subscription must be on the folder only(not children)

events - the events to subscribe to

Throws:

ServerException - error in the server application

deleteSubscriptions

void deleteSubscriptions(long[] ids)
                  throws ServerException

Deletes a list of Subscriptions

Parameters:

ids - identifiers of the subscriptions

Throws:

ServerException - error in the server application