Package com.logicaldoc.importfolder.webservice.soap

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 Type	Method	Description
void	delete(String sid, long folderId)	Deletes an imported folder with the given identifier
WSImportFolder[]	list(String sid)	Gets folder metadata of all imported folders
long	store(String sid, WSImportFolder folder)	Create/Update an imported folder.

Method Detail

list

WSImportFolder[] list(String sid)
               throws Exception

Gets folder metadata of all imported folders

Parameters:

sid - Session identifier

Returns:

A value object containing the folders metadata

Throws:

Exception - error in the server

store

long store(String sid,
           WSImportFolder folder)
    throws Exception

Create/Update an imported folder. You can completely customize the imported folder through a value object containing the folder's metadata

Parameters:

sid - Session identifier

folder - Web service value object containing the folder's metadata

Returns:

id of the created/updated import folder

Throws:

Exception - error in the server

delete

void delete(String sid,
            long folderId)
     throws Exception

Deletes an imported folder with the given identifier

Parameters:

sid - Session identifier

folderId - The folder id

Throws:

Exception - error in the server