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
List<WSHistory>	getDocumentHistory(String sid, long docId)	Gets the history of a given document
List<WSHistory>	getHistories(String sid, String path, String sidFilter, Long userId, String dateStart, String dateEnd, List<String> events, Integer max)	Lists all the histories by the given criteria.
List<WSHistory>	getHistory(String sid, long folderId, String oldestDate, List<String> events, Integer max)	Lists all the document and folder histories in the given tree
List<WSHistory>	getLatestHistory(String sid, long folderId, String oldestDate, List<String> events, Integer max)	Lists all the document and folder histories in the given tree but just the more recent entry for each object(document or folder)
List<WSMessage>	getMessages(String sid)	Lists messages routed to the current user
List<WSSubscription>	getSubscriptions(String sid)	Lists all the subscriptions of the current user
List<WSHistory>	getUserHistories(String sid, String username, Long userId, String oldestDate, List<String> events, Integer max)	Retrieves the user histories.
void	markAsRead(String sid, List<Long> ids)	Marks a set of messages as read by the current user
WSHistory	saveDocumentHistory(String sid, WSHistory history)	Saves a document history
void	subscribe(String sid, List<Long> ids, String type, String events)	Subscribes the current user to notifications emitted by documents or folders
void	unsubscribe(String sid, List<Long> ids, String type)	Unsubscribes the current user to notifications emitted by documents or folders

Method Details

subscribe

void subscribe(String sid,
 List<Long> ids,
 String type,
 String events)
        throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

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:

com.logicaldoc.core.PersistenceException - Error in the database

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

unsubscribe

void unsubscribe(String sid,
 List<Long> ids,
 String type)
          throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

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:

com.logicaldoc.core.PersistenceException - Error in the database

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

getSubscriptions

List<WSSubscription> getSubscriptions(String sid)
                               throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Lists all the subscriptions of the current user

Parameters:

sid - identifier of the session

Returns:

array of subscriptions

Throws:

com.logicaldoc.core.PersistenceException - Error in the database

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

getMessages

List<WSMessage> getMessages(String sid)
                     throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Lists messages routed to the current user

Parameters:

sid - identifier of the session

Returns:

array of messages

Throws:

com.logicaldoc.core.PersistenceException - Error in the database

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

markAsRead

void markAsRead(String sid,
 List<Long> ids)
         throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Marks a set of messages as read by the current user

Parameters:

sid - identifier of the session

ids - identifiers of messages

Throws:

com.logicaldoc.core.PersistenceException - Error in the database

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

getHistories

List<WSHistory> getHistories(String sid,
 String path,
 String sidFilter,
 Long userId,
 String dateStart,
 String dateEnd,
 List<String> events,
 Integer max)
                      throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
com.logicaldoc.core.security.authorization.PermissionException

Lists all the histories by the given criteria. Only those users with access to Last Changes report can invoke this method.

Parameters:

sid - The session identifier

path - A path expression to use as filter

sidFilter - A SID expression to use as filter

userId - user identifier

dateStart - oldest date

dateEnd - earliest date

events - list of events

max - maximum number of records

Returns:

the list of histories

Throws:

com.logicaldoc.core.PersistenceException - Error in the database

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

com.logicaldoc.core.security.authorization.PermissionException - The user does not have the required permission

getHistory

List<WSHistory> getHistory(String sid,
 long folderId,
 String oldestDate,
 List<String> events,
 Integer max)
                    throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Lists all the document and folder histories in the given tree

Parameters:

sid - The session identifier

folderId - The tree to inspect

oldestDate - Optional oldest date to use as filter

events - Optional list 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:

com.logicaldoc.core.PersistenceException - Error in the database

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

getLatestHistory

List<WSHistory> getLatestHistory(String sid,
 long folderId,
 String oldestDate,
 List<String> events,
 Integer max)
                          throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Lists all the document and folder histories in the given tree but just the more recent entry for each object(document or folder)

Parameters:

sid - The session identifier

folderId - The tree to inspect

oldestDate - Optional oldest date to use as filter

events - Optional list 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:

com.logicaldoc.core.PersistenceException - Error in the database

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

getDocumentHistory

List<WSHistory> getDocumentHistory(String sid,
 long docId)
                            throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
com.logicaldoc.core.security.authorization.PermissionException

Gets the history of a given document

Parameters:

sid - Session identifier

docId - The document id

Returns:

List of history records

Throws:

com.logicaldoc.core.PersistenceException - Error in the database

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

com.logicaldoc.core.security.authorization.PermissionException - The user does not have the required permission

saveDocumentHistory

WSHistory saveDocumentHistory(String sid,
 WSHistory history)
                       throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Saves a document history

Parameters:

sid - Session identifier

history - The history to save

Returns:

The saved History

Throws:

com.logicaldoc.core.PersistenceException - Error in the database

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

getUserHistories

List<WSHistory> getUserHistories(String sid,
 String username,
 Long userId,
 String oldestDate,
 List<String> events,
 Integer max)
                          throws com.logicaldoc.core.PersistenceException,
com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.security.authorization.PermissionException

Retrieves the user histories. Only those users with access to Last Changes report can invoke this method.

Parameters:

sid - Session identifier

username - optional username to use as filter

userId - optional user id to use as filter

oldestDate - optional date id to use as filter

events - optional list of event names

max - maximum number of returned records

Returns:

the history records

Throws:

com.logicaldoc.core.PersistenceException - Error in the database

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

com.logicaldoc.core.security.authorization.PermissionException - The user does not have the required permission