com.openkm.module

Interface FolderModule

All Known Implementing Classes:

DbFolderModule, JcrFolderModule, OKMFolder

public interface FolderModule

Method Summary

Methods

Modifier and Type	Method and Description
void	copy(String token, String fldPath, String dstPath) Copy a folder to another location in the repository.
Folder	create(String token, Folder fld) Create a new folder in the repository.
void	delete(String token, String fldPath) Delete a folder the repository.
List<Folder>	getChildren(String token, String fldPath) Retrieve a list of children folders from an existing one.
List<Folder>	getChilds(String token, String fldPath) Deprecated.
ContentInfo	getContentInfo(String token, String fldPath) Retrive the content info of the folder: number of folders, number of documents, and total size.
String	getPath(String token, String uuid) Get the folder path from a UUID
Folder	getProperties(String token, String fldPath) Obtains properties from a previously created folder.
boolean	isValid(String token, String fldId) Test if a folder path is valid.
void	move(String token, String fldPath, String dstPath) Move a folder to another location in the repository.
void	purge(String token, String fldPath) Deletes definitively a folder from the repository.
Folder	rename(String token, String fldPath, String newName) Rename a folder in the repository.

Method Detail

create

Folder create(String token,
            Folder fld)
              throws PathNotFoundException,
                     ItemExistsException,
                     AccessDeniedException,
                     RepositoryException,
                     DatabaseException,
                     ExtensionException,
                     AutomationException

Create a new folder in the repository.

Parameters:

fld - A folder object with the new folder properties.

Returns:

A folder object with the new created folder properties.

Throws:

PathNotFoundException - If the parent folder doesn't exist.

ItemExistsException - If there is already a folder in the repository with the same name in the same path.

AccessDeniedException - If there is any security problem: you can't modify the parent folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

ExtensionException

AutomationException

getProperties

Folder getProperties(String token,
                   String fldPath)
                     throws PathNotFoundException,
                            RepositoryException,
                            DatabaseException

Obtains properties from a previously created folder.

Parameters:

fldPath - The path that identifies an unique folder.

Returns:

A folder object with the selected folder properties.

Throws:

PathNotFoundException - If the indicated folder doesn't exist.

RepositoryException - If there is any general repository problem.

DatabaseException

delete

void delete(String token,
          String fldPath)
            throws LockException,
                   PathNotFoundException,
                   AccessDeniedException,
                   RepositoryException,
                   DatabaseException

Delete a folder the repository. It is a logical delete, so really is moved to the user trash and can be restored.

Parameters:

fldPath - The path that identifies an unique folder.

Throws:

LockException - Can't delete a folder with locked documents.

PathNotFoundException - If there is no folder in the repository in this path.

AccessDeniedException - If there is any security problem: you can't modify the folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

purge

void purge(String token,
         String fldPath)
           throws LockException,
                  PathNotFoundException,
                  AccessDeniedException,
                  RepositoryException,
                  DatabaseException

Deletes definitively a folder from the repository. It is a phisical delete, so the folder can't be restored.

Parameters:

fldPath - The path that identifies an unique folder.

Throws:

LockException - Can't delete a folder with locked documents.

PathNotFoundException - If there is no folder in the repository in this path.

AccessDeniedException - If there is any security problem: you can't modify the folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

rename

Folder rename(String token,
            String fldPath,
            String newName)
              throws PathNotFoundException,
                     ItemExistsException,
                     AccessDeniedException,
                     RepositoryException,
                     DatabaseException

Rename a folder in the repository.

Parameters:

fldPath - The path that identifies an unique folder.

newName - The new folder name.

Returns:

A folder object with the new folder properties.

Throws:

PathNotFoundException - If there is no folder in the repository in this path.

ItemExistsException - If there is already a folder in the repository with the same name in the same path.

AccessDeniedException - If there is any security problem: you can't modify the folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

move

void move(String token,
        String fldPath,
        String dstPath)
          throws PathNotFoundException,
                 ItemExistsException,
                 AccessDeniedException,
                 RepositoryException,
                 DatabaseException

Move a folder to another location in the repository.

Parameters:

fldPath - The path that identifies an unique folder.

dstPath - The path of the destination folder.

Throws:

PathNotFoundException - If the dstPath does not exists.

ItemExistsException - If there is already a folder in the destination folder with the same name.

AccessDeniedException - If there is any security problem: you can't modify the parent folder or the destination folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

copy

void copy(String token,
        String fldPath,
        String dstPath)
          throws PathNotFoundException,
                 ItemExistsException,
                 AccessDeniedException,
                 RepositoryException,
                 IOException,
                 AutomationException,
                 DatabaseException,
                 UserQuotaExceededException

Copy a folder to another location in the repository.

Parameters:

fldPath - The path that identifies an unique folder.

dstPath - The path of the destination folder.

Throws:

PathNotFoundException - If the dstPath does not exists.

ItemExistsException - If there is already a folder in the destination folder with the same name.

AccessDeniedException - If there is any security problem: you can't modify the parent folder or the destination folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

IOException

AutomationException

DatabaseException

UserQuotaExceededException

getChilds

@Deprecated
List<Folder> getChilds(String token,
                                String fldPath)
                       throws PathNotFoundException,
                              RepositoryException,
                              DatabaseException

Deprecated.

Retrieve a list of child folders from an existing one.

Parameters:

fldPath - The path that identifies an unique folder.

Returns:

A Collection with the child folders.

Throws:

PathNotFoundException - If there is no folder in the repository in this path

RepositoryException - If there is any general repository problem.

DatabaseException

getChildren

List<Folder> getChildren(String token,
                       String fldPath)
                         throws PathNotFoundException,
                                RepositoryException,
                                DatabaseException

Retrieve a list of children folders from an existing one.

Parameters:

fldPath - The path that identifies an unique folder.

Returns:

A Collection with the child folders.

Throws:

PathNotFoundException - If there is no folder in the repository in this path

RepositoryException - If there is any general repository problem.

DatabaseException

getContentInfo

ContentInfo getContentInfo(String token,
                         String fldPath)
                           throws AccessDeniedException,
                                  RepositoryException,
                                  PathNotFoundException,
                                  DatabaseException

Retrive the content info of the folder: number of folders, number of documents, and total size.

Parameters:

fldPath - The path that identifies an unique folder.

Returns:

A ContentInfo with the number of folder, number of documents and total size.

Throws:

AccessDeniedException - If there is any security problem: you can't access this folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

PathNotFoundException - If there is no folder in the repository with this path.

DatabaseException

isValid

boolean isValid(String token,
              String fldId)
                throws PathNotFoundException,
                       RepositoryException,
                       DatabaseException

Test if a folder path is valid.

Parameters:

fldId - The path that identifies an unique folder or its UUID.

Returns:

True if is a valid folder path, otherwise false.

Throws:

PathNotFoundException - If the node does not exists.

RepositoryException - If there is any general repository problem.

DatabaseException

getPath

String getPath(String token,
             String uuid)
               throws AccessDeniedException,
                      RepositoryException,
                      DatabaseException

Get the folder path from a UUID

Parameters:

uuid - The unique folder id.

Returns:

The folder path

Throws:

AccessDeniedException - If there is any security problem: you can't access this folder because of lack of permissions.

RepositoryException - If there is any problem.

DatabaseException