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 Summary
All Methods Instance Methods Abstract 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 form)
Creates/Updates a form
-
-
-
Method Detail
-
list
WSForm[] list(String sid) throws Exception
Lists all the available froms in the tenant- Parameters:
sid
- Session identifier- Returns:
- the list of form definitions
- Throws:
Exception
- If it was not possible to list the forms
-
store
WSForm store(String sid, WSForm form) throws Exception
Creates/Updates a form- Parameters:
sid
- Session identifierform
- the form to create/update- Returns:
- the newly created form
- Throws:
Exception
- If it was not possible to store the form
-
delete
void delete(String sid, long formId) throws Exception
Deletes an existing form- Parameters:
sid
- Session identifierformId
- the identifier of the form- Throws:
Exception
- If any error happens
-
getForm
WSForm getForm(String sid, long formId) throws Exception
Gets an existing form- Parameters:
sid
- Session identifierformId
- the identifier of the form- Returns:
- the The found form's definition
- Throws:
Exception
- If any error happens
-
getFormByName
WSForm getFormByName(String sid, String name) throws Exception
Gets an existing form- Parameters:
sid
- Session identifiername
- the name of the form- Returns:
- the The found form's definition
- Throws:
Exception
- If any error happens
-
createDocument
com.logicaldoc.webservice.model.WSDocument createDocument(String sid, long formId, com.logicaldoc.webservice.model.WSDocument doc) throws Exception
Create a new document rendered with the given form- 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
-
-