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

Interface ContactService

  • All Superinterfaces:
    com.google.gwt.user.client.rpc.RemoteService
    All Known Implementing Classes:
    ContactServiceImpl
    @RemoteServiceRelativePath("contact")
public interface ContactService
extends com.google.gwt.user.client.rpc.RemoteService
    The client side stub for the Contact Service. This service allows r/w operations on contacts.
    Since:
    6.0
    Author:
    Marco Meschieri - LogicalDOC

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  ContactService.Instance  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void delete​(long[] ids)
      Deletes a selection of contacts
      GUIContact load​(long id)
      Loads a contact from the database
      GUIContact[] parseContacts​(boolean preview, String separator, String delimiter, boolean skipFirstRow, int firstName, int lastName, int email, int company, int phone, int mobile, int address)
      Reads the contacts that are about to be imported from CSV file
      void save​(GUIContact contact)
      Saves a contact in the database
      void shareContacts​(long[] contactIds, long[] userIds, long[] groupIds)
      Shares contacts among a set of users and groups

    • Method Detail

      • delete

        void delete​(long[] ids)
     throws ServerException
        Deletes a selection of contacts
        Parameters:
        ids - identifiers of the contacts to delete
        Throws:
        ServerException - an error happened in the server application

      • save

        void save​(GUIContact contact)
   throws ServerException
        Saves a contact in the database
        Parameters:
        contact - the contact to save
        Throws:
        ServerException - an error happened in the server application

      • load

        GUIContact load​(long id)
         throws ServerException
        Loads a contact from the database
        Parameters:
        id - identifier of the contact
        Returns:
        the contact retrieved by the server application
        Throws:
        ServerException - an error happened in the server application

      • parseContacts

        GUIContact[] parseContacts​(boolean preview,
                           String separator,
                           String delimiter,
                           boolean skipFirstRow,
                           int firstName,
                           int lastName,
                           int email,
                           int company,
                           int phone,
                           int mobile,
                           int address)
                    throws ServerException
        Reads the contacts that are about to be imported from CSV file
        Parameters:
        preview - if the preview must be shown
        separator - the separator char
        delimiter - the fields delimiter
        skipFirstRow - if the first row contains titles and mus be skipped
        firstName - the first name
        lastName - the last name
        email - the email
        company - the company
        phone - the phone
        mobile - the mobile phone
        address - the address
        Returns:
        the extracted contacts
        Throws:
        ServerException - an error happened in the server application

      • shareContacts

        void shareContacts​(long[] contactIds,
                   long[] userIds,
                   long[] groupIds)
            throws ServerException
        Shares contacts among a set of users and groups
        Parameters:
        contactIds - identifiers of the contacts to share
        userIds - direct ids of users to share the contacts with
        groupIds - the groups of users to share the contacts with
        Throws:
        ServerException - share the search to