Package com.logicaldoc.audit.webservice.soap

Interface AuditService

All Known Implementing Classes:

SoapAuditClient, SoapAuditService

public interface AuditService

Web Service definition interface for Notifications and Messages

Since:

6.5

Author:

Matteo Caruso - LogicalDOC

Method Summary

Modifier and Type	Method	Description
WSHistory[]	getDocumentHistory(String sid, long docId)	Gets the history of a given document
WSHistory[]	getHistory(String sid, long folderId, String oldestDate, String[] events, Integer max)	Lists all the histories in the given path
WSMessage[]	getMessages(String sid)	Lists messages routed to the current user
WSSubscription[]	getSubscriptions(String sid)	Lists all the subscriptions of the current user
void	markAsRead(String sid, long[] ids)	Marks a set of messages as read by the current user
void	subscribe(String sid, Long[] ids, String type, String events)	Subscribes the current user to notifications emitted by documents or folders
void	unsubscribe(String sid, Long[] ids, String type)	Unsubscribes the current user to notifications emitted by documents or folders

Method Detail

subscribe

void subscribe(String sid,
               Long[] ids,
               String type,
               String events)
        throws Exception

Subscribes the current user to notifications emitted by documents or folders

Parameters:

sid - The session identifier

ids - The ids of documents or folders

type - one of Subscription.TYPE_x

events - Optional list of event codes separated by comma

Throws:

Exception - error

unsubscribe

void unsubscribe(String sid,
                 Long[] ids,
                 String type)
          throws Exception

Unsubscribes the current user to notifications emitted by documents or folders

Parameters:

sid - The session identifier

ids - The ids of documents or folders

type - one of Subscription.TYPE_x

Throws:

Exception - error

getSubscriptions

WSSubscription[] getSubscriptions(String sid)
                           throws Exception

Lists all the subscriptions of the current user

Parameters:

sid - identifier of the session

Returns:

array of subscriptions

Throws:

Exception - error

getMessages

WSMessage[] getMessages(String sid)
                 throws Exception

Lists messages routed to the current user

Parameters:

sid - identifier of the session

Returns:

array of messages

Throws:

Exception - error

markAsRead

void markAsRead(String sid,
                long[] ids)
         throws Exception

Marks a set of messages as read by the current user

Parameters:

sid - identifier of the session

ids - identifiers of messages

Throws:

Exception - error

getHistory

WSHistory[] getHistory(String sid,
                       long folderId,
                       String oldestDate,
                       String[] events,
                       Integer max)
                throws Exception

Lists all the histories in the given path

Parameters:

sid - The session identifier

folderId - The tree to inspect

oldestDate - Optional oldest date to use as filter

events - Optional array of event codes to use as filter

max - Optional hint on the maximum number of records for each history type(document, folder ...)

Returns:

The list of histories

Throws:

Exception - error

getDocumentHistory

WSHistory[] getDocumentHistory(String sid,
                               long docId)
                        throws Exception

Gets the history of a given document

Parameters:

sid - Session identifier

docId - The document id

Returns:

Array of history records

Throws:

Exception - error