Class SoapFormClient
java.lang.Object
com.logicaldoc.webservice.soap.client.SoapClient<FormService>
com.logicaldoc.form.webservice.soap.client.SoapFormClient
- All Implemented Interfaces:
FormService
public class SoapFormClient
extends com.logicaldoc.webservice.soap.client.SoapClient<FormService>
implements FormService
Java client to invoke the Form service
- Since:
- 7.4.1
- Author:
- Marco Meschieri - LogicalDOC
-
Constructor Summary
ConstructorDescriptionSoapFormClient
(String endpoint) SoapFormClient
(String endpoint, int gzipThreshold, boolean log, int timeout) -
Method Summary
Modifier and TypeMethodDescriptioncom.logicaldoc.webservice.model.WSDocument
createDocument
(String sid, long formId, com.logicaldoc.webservice.model.WSDocument doc) Create a new document rendered with the given formvoid
Deletes an existing formGets an existing formgetFormByName
(String sid, String name) Gets an existing formLists all the available froms in the tenantCreates/Updates a form
-
Constructor Details
-
SoapFormClient
-
SoapFormClient
-
-
Method Details
-
list
public 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 Description copied from interface:FormService
Lists all the available froms in the tenant- Specified by:
list
in interfaceFormService
- Parameters:
sid
- Session identifier- Returns:
- the list of form definitions
- Throws:
com.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticatedcom.logicaldoc.core.security.authorization.PermissionException
- The user does not have enough permissionscom.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- The feature is not enabled in the license
-
store
public 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 Description copied from interface:FormService
Creates/Updates a form- Specified by:
store
in interfaceFormService
- Parameters:
sid
- Session identifierform
- the form to create/update- Returns:
- the newly created form
- Throws:
com.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticatedcom.logicaldoc.core.security.authorization.PermissionException
- The user does not have enough permissionscom.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- 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 interfaceFormService
- Parameters:
sid
- Session identifiername
- the name of the form- Returns:
- the The found form's definition
- Throws:
com.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticatedcom.logicaldoc.core.security.authorization.PermissionException
- The user does not have enough permissionscom.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- 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 interfaceFormService
- Parameters:
sid
- Session identifierformId
- the identifier of the form- Throws:
com.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticatedcom.logicaldoc.core.security.authorization.PermissionException
- The user does not have enough permissionscom.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- 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 interfaceFormService
- Parameters:
sid
- Session identifierformId
- the identifier of the form- Returns:
- the The found form's definition
- Throws:
com.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticatedcom.logicaldoc.core.security.authorization.PermissionException
- The user does not have enough permissionscom.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- 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.core.security.authorization.PermissionException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, FeatureNotEnabledException, com.logicaldoc.core.security.authorization.UnexistingResourceException Description copied from interface:FormService
Create a new document rendered with the given form- Specified by:
createDocument
in interfaceFormService
- Parameters:
sid
- Session identifierformId
- The identifier of the formdoc
- 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 authenticatedcom.logicaldoc.core.security.authorization.PermissionException
- The user does not have enough permissionscom.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- The feature is not enabled in the licensecom.logicaldoc.core.security.authorization.UnexistingResourceException
- The specified form does not exist
-