Package com.logicaldoc.webservice.rest.client

Class RestFolderClient

java.lang.Object

com.logicaldoc.webservice.rest.client.AbstractRestClient<FolderService>

com.logicaldoc.webservice.rest.client.RestFolderClient

public class RestFolderClient
extends AbstractRestClient<FolderService>

Constructor Summary

Constructors

Constructor	Description
RestFolderClient(String endpoint, String apiKey)
RestFolderClient(String endpoint, String apiKey, int timeout)

Method Summary

Modifier and Type	Method	Description
WSFolder	create(WSFolder folder)
long	createFolder(long parentId, String folderName)
WSFolder	createPath(long rootFolder, String path)
void	delete(long folderId)
WSFolder	findByPath(String path)
WSFolder	getFolder(long folderId)
WSFolder	getRootFolder()
List<WSFolder>	list(long folderId, String sort, Integer page, Integer max)
List<WSFolder>	listChildren(long folderId)
void	update(WSFolder folder)

Methods inherited from class java.lang.Object

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

Constructor Details

RestFolderClient

public RestFolderClient(String endpoint,
 String apiKey)

RestFolderClient

public RestFolderClient(String endpoint,
 String apiKey,
 int timeout)

Method Details

listChildren

public List<WSFolder> listChildren(long folderId)
                            throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

list

public List<WSFolder> list(long folderId,
 String sort,
 Integer page,
 Integer max)
                    throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

create

public WSFolder create(WSFolder folder)
                throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

createPath

public WSFolder createPath(long rootFolder,
 String path)
                    throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

findByPath

public WSFolder findByPath(String path)
                    throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

getRootFolder

public WSFolder getRootFolder()
                       throws AuthenticationException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

WebserviceException

PersistenceException

getFolder

public WSFolder getFolder(long folderId)
                   throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

createFolder

public long createFolder(long parentId,
 String folderName)
                  throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

delete

public void delete(long folderId)
            throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

update

public void update(WSFolder folder)
            throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException