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 SoapFormService()
-
Method Summary
All Methods Instance Methods Concrete Methods 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 formvoid
delete(String sid, long formId)
Deletes an existing formWSForm
getForm(String sid, long formId)
Gets an existing formWSForm
getFormByName(String sid, String name)
Gets an existing formWSForm[]
list(String sid)
Lists all the available froms in the tenantWSForm
store(String sid, WSForm frm)
Creates/Updates a form
-
-
-
Method Detail
-
list
public WSForm[] list(String sid) throws Exception
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:
Exception
- If it was not possible to list the forms
-
store
public WSForm store(String sid, WSForm frm) throws Exception
Description copied from interface:FormService
Creates/Updates a form- Specified by:
store
in interfaceFormService
- Parameters:
sid
- Session identifierfrm
- the form to create/update- Returns:
- the newly created form
- Throws:
Exception
- If it was not possible to store the form
-
delete
public void delete(String sid, long formId) throws Exception
Description copied from interface:FormService
Deletes an existing form- Specified by:
delete
in interfaceFormService
- Parameters:
sid
- Session identifierformId
- the identifier of the form- Throws:
Exception
- If any error happens
-
getForm
public WSForm getForm(String sid, long formId) throws Exception
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:
Exception
- If any error happens
-
getFormByName
public WSForm getFormByName(String sid, String name) throws Exception
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:
Exception
- If any error happens
-
createDocument
public com.logicaldoc.webservice.model.WSDocument createDocument(String sid, long formId, com.logicaldoc.webservice.model.WSDocument doc) throws Exception
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:
Exception
- If any error happens
-
-