Package com.logicaldoc.webservice.soap

Interface FolderService

All Known Implementing Classes:

RestFolderService, RestFolderSwagger, SoapFolderClient, SoapFolderService

public interface FolderService

Folder Web Service definition interface

Since:

5.2

Author:

Matteo Caruso - LogicalDOC

Method Summary

Modifier and Type	Method	Description
void	copy(String sid, long folderId, long targetId, int foldersOnly, String securityOption)	Copies an existing folder with the given identifier.
WSFolder	create(String sid, WSFolder folder)	Creates a new folder.
WSFolder	createAlias(String sid, long parentId, long foldRef)	Creates a new folder alias
long	createFolder(String sid, long parentId, String name)	Create a new folder.
WSFolder	createPath(String sid, long parentId, String path)	Creates the folder for the specified path.
void	delete(String sid, long folderId)	Deletes an existing folder.
WSFolder	findByPath(String sid, String path)	Finds the folder at the specified path
WSFolder	getDefaultWorkspace(String sid)	Gets the Default workspace
WSFolder	getFolder(String sid, long folderId)	Gets an existing folder
WSRight[]	getGrantedGroups(String sid, long folderId)	Retrieves the list of granted groups for the given folder
WSRight[]	getGrantedUsers(String sid, long folderId)	Retrieves the list of granted users for the given folder.
WSFolder[]	getPath(String sid, long folderId)	Computes the path from the root to the target folder.
WSFolder	getRootFolder(String sid)	Gets root metadata
void	grantGroup(String sid, long folderId, long groupId, int permissions, boolean recursive)	Grants group permission to the folder
void	grantUser(String sid, long folderId, long userId, int permissions, boolean recursive)	Grants user permission to the folder.
boolean	isGranted(String sid, long folderId, int permission)	Tests if the current user has a specific permission on a folder
boolean	isReadable(String sid, long folderId)	Tests if a folder is readable.
boolean	isWritable(String sid, long folderId)	Tests if a folder is writable
WSFolder[]	listChildren(String sid, long folderId)	Lists all direct folders of a parent folder. Attention: readable only sub-folders are returned.
WSFolder[]	listWorkspaces(String sid)	Retrieves the list of all workspaces.
void	merge(String sid, long sourceId, long targetId)	Merges the contents of folder into a target
void	move(String sid, long folderId, long parentId)	Moves an existing folder with the given identifier.
void	rename(String sid, long folderId, String name)	Renames an existing folder.
void	update(String sid, WSFolder folder)	Updates an existing folder.

Method Detail

create

WSFolder create(String sid,
                WSFolder folder)
         throws AuthenticationException,
                WebserviceException,
                PersistenceException,
                PermissionException

Creates a new folder. The user can completely customize the folder through a value object containing the folder's metadata

Parameters:

sid - Session identifier

folder - value object containing the folder's metadata

Returns:

The value object containing the folder's metadata

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

createAlias

WSFolder createAlias(String sid,
                     long parentId,
                     long foldRef)
              throws AuthenticationException,
                     WebserviceException,
                     PersistenceException,
                     PermissionException

Creates a new folder alias

Parameters:

sid - Session identifier

parentId - The parent folder

foldRef - The referenced folder

Returns:

The newly created alias

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

createFolder

long createFolder(String sid,
                  long parentId,
                  String name)
           throws AuthenticationException,
                  PermissionException,
                  WebserviceException,
                  PersistenceException

Create a new folder.

Parameters:

sid - Session identifier

parentId - The parent's ID

name - The new folder's name

Returns:

The newly created folder ID

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

delete

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

Deletes an existing folder.

Parameters:

sid - Session identifier

folderId - The folder id

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

rename

void rename(String sid,
            long folderId,
            String name)
     throws AuthenticationException,
            WebserviceException,
            PersistenceException,
            PermissionException

Renames an existing folder.

Parameters:

sid - Session identifier

folderId - The folder id

name - The new folder name

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

update

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

Updates an existing folder. To perform this you need the RENAME permission.

Parameters:

sid - Session identifier

folder - The folders metadata(please compile the ID)

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

move

void move(String sid,
          long folderId,
          long parentId)
   throws PersistenceException,
          AuthenticationException,
          WebserviceException

Moves an existing folder with the given identifier.

Parameters:

sid - Session identifier

folderId - The folder id

parentId - The folder id of the new parent folder

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

merge

void merge(String sid,
           long sourceId,
           long targetId)
    throws AuthenticationException,
           WebserviceException,
           PersistenceException,
           PermissionException

Merges the contents of folder into a target

Parameters:

sid - Session identifier

sourceId - Identifier of the source folder

targetId - Identifier of the target folder

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

copy

void copy(String sid,
          long folderId,
          long targetId,
          int foldersOnly,
          String securityOption)
   throws AuthenticationException,
          WebserviceException,
          PersistenceException

Copies an existing folder with the given identifier.

Parameters:

sid - Session identifier

folderId - The folder id

targetId - The folder id of the target folder

foldersOnly - If 1, only the folders will be copied and not the documents

securityOption - How to assign the security policies to the newly created folders:

• null or none: empty security policies
• inherit: the new folder will point to the parent for the security policies
• replicate: the new folder will have a copy of the security policies of the source folder

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getFolder

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

Gets an existing folder

Parameters:

sid - Session identifier

folderId - The folder id

Returns:

A value object containing the folder's metadata

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

getRootFolder

WSFolder getRootFolder(String sid)
                throws AuthenticationException,
                       WebserviceException,
                       PersistenceException

Gets root metadata

Parameters:

sid - Session identifier

Returns:

A value object containing the folder's metadata

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getDefaultWorkspace

WSFolder getDefaultWorkspace(String sid)
                      throws AuthenticationException,
                             WebserviceException,
                             PersistenceException,
                             PermissionException

Gets the Default workspace

Parameters:

sid - Session identifier

Returns:

A value object containing the workspace's metadata

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

listChildren

WSFolder[] listChildren(String sid,
                        long folderId)
                 throws AuthenticationException,
                        WebserviceException,
                        PersistenceException,
                        PermissionException

Lists all direct folders of a parent folder.
Attention: readable only sub-folders are returned.

Parameters:

sid - identifier of th session

folderId - identifier of the folder

Returns:

Array of folders contained in the folder

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

isReadable

boolean isReadable(String sid,
                   long folderId)
            throws AuthenticationException,
                   WebserviceException,
                   PersistenceException

Tests if a folder is readable.

Parameters:

sid - Session identifier

folderId - The folder id

Returns:

True if the identifier denotes a readable folder, otherwise false.

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

isWritable

boolean isWritable(String sid,
                   long folderId)
            throws AuthenticationException,
                   WebserviceException,
                   PersistenceException

Tests if a folder is writable

Parameters:

sid - Session identifier

folderId - The folder id

Returns:

True if the identifier denotes a writable folder, otherwise false

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

isGranted

boolean isGranted(String sid,
                  long folderId,
                  int permission)
           throws AuthenticationException,
                  WebserviceException,
                  PersistenceException

Tests if the current user has a specific permission on a folder

Parameters:

sid - Session identifier

folderId - The folder id

permission - The permission representation

Returns:

True if the identifier denotes a granted permission, otherwise false

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getPath

WSFolder[] getPath(String sid,
                   long folderId)
            throws AuthenticationException,
                   WebserviceException,
                   PersistenceException,
                   PermissionException

Computes the path from the root to the target folder.

Parameters:

sid - Session identifier

folderId - The target folder id

Returns:

The list of folder, the first is the root, the last is the target folder

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

grantUser

void grantUser(String sid,
               long folderId,
               long userId,
               int permissions,
               boolean recursive)
        throws PersistenceException,
               PermissionException,
               AuthenticationException,
               WebserviceException

Grants user permission to the folder.

Parameters:

sid - Session identifier

folderId - Folder id

userId - User Id

permissions - the permission integer representation. If '0', the user will be not granted to access the folder.

recursive - recursion option. If true, the grant operation is applied also to the subfolders.

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

grantGroup

void grantGroup(String sid,
                long folderId,
                long groupId,
                int permissions,
                boolean recursive)
         throws PermissionException,
                PersistenceException,
                AuthenticationException,
                WebserviceException

Grants group permission to the folder

Parameters:

sid - Session identifier

folderId - Folder id

groupId - Group Id

permissions - the permission integer representation. If '0', the group will be not granted to access the folder.

recursive - recursion option. If true, the grant operation is applied also to the subfolders

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

getGrantedUsers

WSRight[] getGrantedUsers(String sid,
                          long folderId)
                   throws AuthenticationException,
                          WebserviceException,
                          PersistenceException

Retrieves the list of granted users for the given folder.

Parameters:

sid - Session identifier

folderId - Folder id

Returns:

'error' if error occurred, the right objects collection.

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getGrantedGroups

WSRight[] getGrantedGroups(String sid,
                           long folderId)
                    throws AuthenticationException,
                           WebserviceException,
                           PersistenceException

Retrieves the list of granted groups for the given folder

Parameters:

sid - Session identifier

folderId - Folder id

Returns:

'error' if error occurred, the right objects collection

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

createPath

WSFolder createPath(String sid,
                    long parentId,
                    String path)
             throws AuthenticationException,
                    WebserviceException,
                    PersistenceException,
                    PermissionException

Creates the folder for the specified path. All unexisting nodes specified in the path will be created

Parameters:

sid - Session identifier

parentId - The parent folder

path - The folder's path(for example /Default/dog/cat/mouse)

Returns:

the folder that represents the given path

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

findByPath

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

Finds the folder at the specified path

Parameters:

sid - Session identifier

path - The folder's path(for example /Default/dog/cat/mouse)

Returns:

The created folder

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

listWorkspaces

WSFolder[] listWorkspaces(String sid)
                   throws AuthenticationException,
                          WebserviceException,
                          PersistenceException

Retrieves the list of all workspaces.

Parameters:

sid - Session identifier

Returns:

array of workspaces

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session