Interface ImportFolderService
- All Known Implementing Classes:
SoapImportFolderClient
,SoapImportFolderService
public interface ImportFolderService
WebService administration of import folders
- Since:
- 6.1
- Author:
- Marco Meschieri - LogicalDOC
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Deletes an imported folder with the given identifierGets folder metadata of all imported folderslong
store
(String sid, WSImportFolder folder) Create/Update an imported folder.
-
Method Details
-
list
List<WSImportFolder> list(String sid) throws FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Gets folder metadata of all imported folders- Parameters:
sid
- Session identifier- Returns:
- A value object containing the folders metadata
- Throws:
FeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.webservice.WebserviceException
- Error in the webservice
-
store
long store(String sid, WSImportFolder folder) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, FeatureNotEnabledException Create/Update an imported folder. You can completely customize the imported folder through a value object containing the folder's metadata- Parameters:
sid
- Session identifierfolder
- Web service value object containing the folder's metadata- Returns:
- id of the created/updated import folder
- Throws:
FeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.webservice.WebserviceException
- Error in the webservice
-
delete
void delete(String sid, long folderId) throws com.logicaldoc.core.PersistenceException, com.logicaldoc.webservice.WebserviceException Deletes an imported folder with the given identifier- Parameters:
sid
- Session identifierfolderId
- The folder id- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.webservice.WebserviceException
- Error in the webservice
-