Package com.logicaldoc.form.webservice.soap.client

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

Constructors

Constructor	Description
SoapFormClient(String endpoint)
SoapFormClient(String endpoint, int gzipThreshold, boolean log, int timeout)

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
WSForm	getForm(String sid, long formId)	Gets an existing form
WSForm	getFormByName(String sid, String name)	Gets an existing form
WSForm[]	list(String sid)	Lists all the available froms in the tenant
WSForm	store(String sid, WSForm form)	Creates/Updates a form

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SoapFormClient

public SoapFormClient(String endpoint,
 int gzipThreshold,
 boolean log,
 int timeout)

SoapFormClient

public SoapFormClient(String endpoint)

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 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 interface FormService

Parameters:

sid - Session identifier

form - 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

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

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

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 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.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

com.logicaldoc.core.security.authorization.UnexistingResourceException - The specified form does not exist