Package com.logicaldoc.importfolder.webservice.soap.client

Class SoapImportFolderClient

java.lang.Object

com.logicaldoc.webservice.soap.client.SoapClient<ImportFolderService>

com.logicaldoc.importfolder.webservice.soap.client.SoapImportFolderClient

All Implemented Interfaces:

ImportFolderService

public class SoapImportFolderClient
extends com.logicaldoc.webservice.soap.client.SoapClient<ImportFolderService>
implements ImportFolderService

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	delete(String sid, long id)	Deletes an imported folder with the given identifier
WSImportFolder[]	list(String sid)	Gets folder metadata of all imported folders
long	store(String sid, WSImportFolder importFolder)	Create/Update an imported folder.

Methods inherited from class java.lang.Object

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

Constructor Details

SoapImportFolderClient

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

SoapImportFolderClient

public SoapImportFolderClient(String endpoint)

Method Details

list

public WSImportFolder[] list(String sid)
                      throws FeatureNotEnabledException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: ImportFolderService

Gets folder metadata of all imported folders

Specified by:

list in interface ImportFolderService

Parameters:

sid - Session identifier

Returns:

A value object containing the folders metadata

Throws:

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.PersistenceException - Error in the data layer

store

public long store(String sid,
 WSImportFolder importFolder)
           throws com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
FeatureNotEnabledException

Description copied from interface: ImportFolderService

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

Specified by:

store in interface ImportFolderService

Parameters:

sid - Session identifier

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

Returns:

id of the created/updated import folder

Throws:

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.PersistenceException - Error in the data layer

FeatureNotEnabledException - Feature not enabled in the license

delete

public void delete(String sid,
 long id)
            throws com.logicaldoc.core.PersistenceException,
com.logicaldoc.webservice.WebserviceException

Description copied from interface: ImportFolderService

Deletes an imported folder with the given identifier

Specified by:

delete in interface ImportFolderService

Parameters:

sid - Session identifier

id - The folder id

Throws:

com.logicaldoc.core.PersistenceException - Error in the data layer

com.logicaldoc.webservice.WebserviceException - Error in the webservice