Class SoapAuditService

  • All Implemented Interfaces:
    AuditService

    public class SoapAuditService
    extends com.logicaldoc.webservice.AbstractService
    implements AuditService
    Implementation of NotificationService
    Since:
    6.5
    Author:
    Marco Meschieri - LogicalDOC
    • Constructor Detail

      • SoapAuditService

        public SoapAuditService()
    • Method Detail

      • subscribe

        public void subscribe​(String sid,
                              Long[] ids,
                              String type,
                              String events)
                       throws Exception
        Description copied from interface: AuditService
        Subscribes the current user to notifications emitted by documents or folders
        Specified by:
        subscribe in interface AuditService
        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

        public void unsubscribe​(String sid,
                                Long[] ids,
                                String type)
                         throws Exception
        Description copied from interface: AuditService
        Unsubscribes the current user to notifications emitted by documents or folders
        Specified by:
        unsubscribe in interface AuditService
        Parameters:
        sid - The session identifier
        ids - The ids of documents or folders
        type - one of Subscription.TYPE_x
        Throws:
        Exception - error
      • markAsRead

        public void markAsRead​(String sid,
                               long[] ids)
                        throws Exception
        Description copied from interface: AuditService
        Marks a set of messages as read by the current user
        Specified by:
        markAsRead in interface AuditService
        Parameters:
        sid - identifier of the session
        ids - identifiers of messages
        Throws:
        Exception - error
      • getHistory

        public WSHistory[] getHistory​(String sid,
                                      long folderId,
                                      String oldestDate,
                                      String[] events,
                                      Integer max)
                               throws Exception
        Description copied from interface: AuditService
        Lists all the histories in the given path
        Specified by:
        getHistory in interface AuditService
        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