com.logicaldoc.gui.frontend.client.services

Interface FolderService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

FolderServiceImpl

@RemoteServiceRelativePath(value="folder")
public interface FolderService
extends com.google.gwt.user.client.rpc.RemoteService

The client side stub for the Folder Service. This service allows r/w operations on folders.

Since:

6.0

Author:

Marco Meschieri - Logical Objects

Method Summary

Methods

Modifier and Type	Method and Description
void	applyMetadata(String sid, long parentId) Applies all extendedAttributes to a sub-tree
void	applyRights(String sid, GUIFolder folder, boolean subfolders) Applies all security settings to folder
void	applyTemplate(String sid, long folderId, long templateId) Applies a template to a folder
GUIFolder	create(String sid, GUIFolder newFolder, boolean inheritSecurity) Creates a new folder
void	delete(String sid, long folderId) Deletes the folder and the subtree
GUIFolder	getFolder(String sid, long folderId, boolean computePath) Gets the Folder initializing the permissions.
GUIValuePair[]	loadTemplates(String sid) Loads the folders templates
void	move(String sid, long folderId, long targetId) Moves a folder under a target folder
void	paste(String sid, long[] docIds, long folderId, String action) Pastes documents into the target folder.
void	pasteAsAlias(String sid, long[] docIds, long folderId) Pastes documents alias into the target folder.
void	rename(String sid, long folderId, String name) Renames the given folder
void	restore(String sid, long folderId, long parentId) Restores a given folder
GUIFolder	save(String sid, GUIFolder folder) Saves the folder in the DB
void	saveTemplates(String sid, GUIValuePair[] templates) Saves the passed folder templates

Method Detail

save

GUIFolder save(String sid,
             GUIFolder folder)
               throws InvalidSessionException

Saves the folder in the DB

Parameters:

folder - The folder to save

Returns:

The saved folder

Throws:

InvalidSessionException

create

GUIFolder create(String sid,
               GUIFolder newFolder,
               boolean inheritSecurity)
                 throws InvalidSessionException

Creates a new folder

Parameters:

newFolder - The folder to be created

inheritSecurity - True if the new folder has to inherit the security policies from the parent

Returns:

The saved folder

Throws:

InvalidSessionException

rename

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

Renames the given folder

Throws:

InvalidSessionException

applyRights

void applyRights(String sid,
               GUIFolder folder,
               boolean subfolders)
                 throws InvalidSessionException

Applies all security settings to folder

Parameters:

sid - The session ID

folder - The folder that contains the new security settings

subfolders - If true, the current security settings will be applied to the sub-folders

Throws:

InvalidSessionException

applyMetadata

void applyMetadata(String sid,
                 long parentId)
                   throws InvalidSessionException

Applies all extendedAttributes to a sub-tree

Parameters:

sid - The session ID

parentId - The parent folder containing the metadata

Throws:

InvalidSessionException

getFolder

GUIFolder getFolder(String sid,
                  long folderId,
                  boolean computePath)
                    throws InvalidSessionException

Gets the Folder initializing the permissions.

Parameters:

folderId - The folder identifier

boolean - True if the complete path must be retrieved

Returns:

The Folder bean

Throws:

InvalidSessionException

delete

void delete(String sid,
          long folderId)
            throws InvalidSessionException

Deletes the folder and the subtree

Throws:

InvalidSessionException

restore

void restore(String sid,
           long folderId,
           long parentId)
             throws InvalidSessionException

Restores a given folder

Throws:

InvalidSessionException

move

void move(String sid,
        long folderId,
        long targetId)
          throws InvalidSessionException

Moves a folder under a target folder

Throws:

InvalidSessionException

paste

void paste(String sid,
         long[] docIds,
         long folderId,
         String action)
           throws InvalidSessionException

Pastes documents into the target folder.

Parameters:

docIds - The documents identifiers.

folderId - The target folder identifier.

action - The action selectee (Clipboard#COPY or Clipboard#COPY).

Throws:

InvalidSessionException

pasteAsAlias

void pasteAsAlias(String sid,
                long[] docIds,
                long folderId)
                  throws InvalidSessionException

Pastes documents alias into the target folder.

Parameters:

docIds - The documents alias identifiers.

folderId - The target folder identifier.

Throws:

InvalidSessionException

loadTemplates

GUIValuePair[] loadTemplates(String sid)
                             throws InvalidSessionException

Loads the folders templates

Throws:

InvalidSessionException

saveTemplates

void saveTemplates(String sid,
                 GUIValuePair[] templates)
                   throws InvalidSessionException

Saves the passed folder templates

Throws:

InvalidSessionException

applyTemplate

void applyTemplate(String sid,
                 long folderId,
                 long templateId)
                   throws InvalidSessionException

Applies a template to a folder

Throws:

InvalidSessionException