Interface FormService

All Known Implementing Classes:
SoapFormClient, SoapFormService

public interface FormService
Form Web Service definition interface
Since:
7.4.1
Author:
Marco Meschieri - LogicalDOC
  • Method Details

    • list

      List<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
      Lists all the available froms in the tenant
      Parameters:
      sid - Session identifier
      Returns:
      the list of form definitions
      Throws:
      FeatureNotEnabledException - The feature is not enabled in the license
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
    • store

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

      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
      Deletes an existing form
      Parameters:
      sid - Session identifier
      formId - the identifier of the form
      Throws:
      FeatureNotEnabledException - The feature is not enabled in the license
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
    • getForm

      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
      Gets an existing form
      Parameters:
      sid - Session identifier
      formId - the identifier of the form
      Returns:
      the The found form's definition
      Throws:
      FeatureNotEnabledException - The feature is not enabled in the license
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
    • getFormByName

      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
      Gets an existing form
      Parameters:
      sid - Session identifier
      name - the name of the form
      Returns:
      the The found form's definition
      Throws:
      FeatureNotEnabledException - The feature is not enabled in the license
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
    • createDocument

      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
      Create a new document rendered with the given form
      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:
      FeatureNotEnabledException - The feature is not enabled in the license
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.core.security.authorization.UnexistingResourceException - The specified form does not exist