com.logicaldoc.webservice.folder

Interface FolderService

All Known Implementing Classes:

FolderClient, FolderServiceImpl

public interface FolderService

Folder Web Service definition interface

Since:

5.2

Author:

Matteo Caruso - Logical Objects

Method Summary

Methods

Modifier and Type	Method and Description
WSFolder	create(String sid, WSFolder folder) 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 with the given identifier.
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 folder metadata of an existing folder with the given identifier.
Right[]	getGrantedGroups(String sid, long folderId) Retrieves the list of granted groups for the given folder.
Right[]	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) Grant group permission to the folder.
void	grantUser(String sid, long folderId, long userId, int permissions, boolean recursive) Grant user permission to the folder.
boolean	isGranted(String sid, long folderId, int permission) Test if the current user has a specific permission.
boolean	isReadable(String sid, long folderId) Test if a folder identifier is readable.
boolean	isWriteable(String sid, long folderId) Test if a folder identifier is writeable.
WSFolder[]	listChildren(String sid, long folderId) Lists all direct folders of a parent folder.
WSFolder[]	listWorkspaces(String sid) Retrieves the list of all workspaces.
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 with the given identifier.
void	update(String sid, WSFolder folder) Updates an existing folder.

Method Detail

create

WSFolder create(String sid,
              WSFolder folder)
                throws Exception

Create 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:

Exception

delete

void delete(String sid,
          long folderId)
            throws Exception

Deletes an existing folder with the given identifier.

Parameters:

sid - Session identifier

folderId - The folder id

Throws:

Exception

rename

void rename(String sid,
          long folderId,
          String name)
            throws Exception

Renames an existing folder with the given identifier.

Parameters:

sid - Session identifier

folderId - The folder id

name - The new folder name

Throws:

Exception

update

void update(String sid,
          WSFolder folder)
            throws Exception

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:

Exception

move

void move(String sid,
        long folderId,
        long parentId)
          throws Exception

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:

Exception

getFolder

WSFolder getFolder(String sid,
                 long folderId)
                   throws Exception

Gets folder metadata of an existing folder with the given identifier.

Parameters:

sid - Session identifier

folderId - The folder id

Returns:

A value object containing the folder's metadata.

Throws:

Exception

getRootFolder

WSFolder getRootFolder(String sid)
                       throws Exception

Gets root metadata

Parameters:

sid - Session identifier

Returns:

A value object containing the folder's metadata.

Throws:

Exception

getDefaultWorkspace

WSFolder getDefaultWorkspace(String sid)
                             throws Exception

Gets the Default workspace

Parameters:

sid - Session identifier

Returns:

A value object containing the workspace's metadata.

Throws:

Exception

isReadable

boolean isReadable(String sid,
                 long folderId)
                   throws Exception

Test if a folder identifier is readable.

Parameters:

sid - Session identifier

folderId - The folder id

Returns:

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

Throws:

Exception

isWriteable

boolean isWriteable(String sid,
                  long folderId)
                    throws Exception

Test if a folder identifier is writeable.

Parameters:

sid - Session identifier

folderId - The folder id

Returns:

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

Throws:

Exception

isGranted

boolean isGranted(String sid,
                long folderId,
                int permission)
                  throws Exception

Test if the current user has a specific permission.

Parameters:

sid - Session identifier

folderId - The folder id

permission - The permission representation

Returns:

True if the identifier denotes a granted permission, otherwise false.

Throws:

Exception

listChildren

WSFolder[] listChildren(String sid,
                      long folderId)
                        throws Exception

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

Parameters:

sid - Session identifier

folderId -

Returns:

Array of folders contained in the folder

Throws:

Exception

getPath

WSFolder[] getPath(String sid,
                 long folderId)
                   throws Exception

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:

Exception

grantUser

void grantUser(String sid,
             long folderId,
             long userId,
             int permissions,
             boolean recursive)
               throws Exception

Grant 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:

Exception

grantGroup

void grantGroup(String sid,
              long folderId,
              long groupId,
              int permissions,
              boolean recursive)
                throws Exception

Grant 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:

Exception

getGrantedUsers

Right[] getGrantedUsers(String sid,
                      long folderId)
                        throws Exception

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:

Exception

getGrantedGroups

Right[] getGrantedGroups(String sid,
                       long folderId)
                         throws Exception

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:

Exception

createPath

WSFolder createPath(String sid,
                  long parentId,
                  String path)
                    throws Exception

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 path(for example /Default/dog/cat/mouse)

Returns:

The created folder

Throws:

Exception

findByPath

WSFolder findByPath(String sid,
                  String path)
                    throws Exception

Finds the folder at the specified path

Parameters:

sid - Session identifier

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

Returns:

The created folder

Throws:

Exception

listWorkspaces

WSFolder[] listWorkspaces(String sid)
                          throws Exception

Retrieves the list of all workspaces.

Parameters:

sid - Session identifier

Returns:

the list of all workspaces

Throws:

Exception