Class SoapFormService

java.lang.Object
com.logicaldoc.webservice.AbstractService
com.logicaldoc.form.webservice.soap.endpoint.SoapFormService
All Implemented Interfaces:
FormService

public class SoapFormService extends com.logicaldoc.webservice.AbstractService implements FormService
Implementation of the FormService
Since:
7.4.1
Author:
Marco Meschieri - LogicalDOC
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    com.logicaldoc.webservice.model.WSDocument
    createDocument(String sid, long formId, com.logicaldoc.webservice.model.WSDocument doc)
    Create a new document rendered with the given form
    void
    delete(String sid, long formId)
    Deletes an existing form
    getForm(String sid, long formId)
    Gets an existing form
    Gets an existing form
    list(String sid)
    Lists all the available froms in the tenant
    store(String sid, WSForm frm)
    Creates/Updates a form

    Methods inherited from class com.logicaldoc.webservice.AbstractService

    convertDateToString, convertStringToDate, getCurrentMessage, isValidateSession, setCurrentMessage, setValidateSession

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • SoapFormService

      public SoapFormService()
  • Method Details

    • list

      public WSForm[] list(String sid) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.core.security.authorization.PermissionException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, FeatureNotEnabledException
      Description copied from interface: FormService
      Lists all the available froms in the tenant
      Specified by:
      list in interface FormService
      Parameters:
      sid - Session identifier
      Returns:
      the list of form definitions
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
      FeatureNotEnabledException - The feature is not enabled in the license
    • store

      public WSForm store(String sid, WSForm frm) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.core.security.authorization.PermissionException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, FeatureNotEnabledException
      Description copied from interface: FormService
      Creates/Updates a form
      Specified by:
      store in interface FormService
      Parameters:
      sid - Session identifier
      frm - the form to create/update
      Returns:
      the newly created form
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
      FeatureNotEnabledException - The feature is not enabled in the license
    • delete

      public void delete(String sid, long formId) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.core.security.authorization.PermissionException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, FeatureNotEnabledException
      Description copied from interface: FormService
      Deletes an existing form
      Specified by:
      delete in interface FormService
      Parameters:
      sid - Session identifier
      formId - the identifier of the form
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
      FeatureNotEnabledException - The feature is not enabled in the license
    • getForm

      public WSForm getForm(String sid, long formId) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.core.security.authorization.PermissionException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, FeatureNotEnabledException
      Description copied from interface: FormService
      Gets an existing form
      Specified by:
      getForm in interface FormService
      Parameters:
      sid - Session identifier
      formId - the identifier of the form
      Returns:
      the The found form's definition
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
      FeatureNotEnabledException - The feature is not enabled in the license
    • getFormByName

      public WSForm getFormByName(String sid, String name) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.core.security.authorization.PermissionException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, FeatureNotEnabledException
      Description copied from interface: FormService
      Gets an existing form
      Specified by:
      getFormByName in interface FormService
      Parameters:
      sid - Session identifier
      name - the name of the form
      Returns:
      the The found form's definition
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
      FeatureNotEnabledException - The feature is not enabled in the license
    • createDocument

      public com.logicaldoc.webservice.model.WSDocument createDocument(String sid, long formId, com.logicaldoc.webservice.model.WSDocument doc) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, FeatureNotEnabledException, com.logicaldoc.core.security.authorization.PermissionException, com.logicaldoc.core.security.authorization.UnexistingResourceException
      Description copied from interface: FormService
      Create a new document rendered with the given form
      Specified by:
      createDocument in interface FormService
      Parameters:
      sid - Session identifier
      formId - The identifier of the form
      doc - The matadata for the creation, please populate the title, the folderId and all the needed extended attributes specified in the form
      Returns:
      The new created document
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
      FeatureNotEnabledException - The feature is not enabled in the license
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      com.logicaldoc.core.security.authorization.UnexistingResourceException - The specified form does not exist