com.openkm.api

Class OKMFolder

java.lang.Object

com.openkm.api.OKMFolder

All Implemented Interfaces:

FolderModule

public class OKMFolder
extends Object
implements FolderModule

Author:

pavila

Method Summary

Methods

Modifier and Type	Method and Description
void	copy(String token, String fldId, String dstId) Copy a folder to another location in the repository.
Folder	create(String token, Folder fld) Create a new folder in the repository.
void	createMissingFolders(String token, String fldPath) Create missing folders.
Folder	createSimple(String token, String fldId)
void	delete(String token, String fldId) Delete a folder the repository.
void	extendedCopy(String token, String fldId, String dstId, ExtendedAttributes extAttr) Copy a folder to another location in the repository.
List<Folder>	getChildren(String token, String fldId) Retrieve a list of children folders from an existing one.
List<Folder>	getChilds(String token, String fldId) Deprecated.
ContentInfo	getContentInfo(String token, String fldId) Retrive the content info of the folder: number of folders, number of documents, and total size.
static OKMFolder	getInstance()
String	getPath(String token, String uuid) Get the folder path from a UUID
Folder	getProperties(String token, String fldId) 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 fldId, String dstId) Move a folder to another location in the repository.
void	purge(String token, String fldId) Deletes definitively a folder from the repository.
Folder	rename(String token, String fldId, String newName) Rename a folder in the repository.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static OKMFolder getInstance()

create

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

Description copied from interface: FolderModule

Create a new folder in the repository.

Specified by:

create in interface FolderModule

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

createSimple

public Folder createSimple(String token,
                  String fldId)
                    throws PathNotFoundException,
                           ItemExistsException,
                           AccessDeniedException,
                           RepositoryException,
                           DatabaseException,
                           ExtensionException,
                           AutomationException

Throws:

PathNotFoundException

ItemExistsException

AccessDeniedException

RepositoryException

DatabaseException

ExtensionException

AutomationException

getProperties

public Folder getProperties(String token,
                   String fldId)
                     throws AccessDeniedException,
                            PathNotFoundException,
                            RepositoryException,
                            DatabaseException

Description copied from interface: FolderModule

Obtains properties from a previously created folder.

Specified by:

getProperties in interface FolderModule

fldId - 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.

AccessDeniedException

DatabaseException

delete

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

Description copied from interface: FolderModule

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

Specified by:

delete in interface FolderModule

fldId - 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

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

Description copied from interface: FolderModule

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

Specified by:

purge in interface FolderModule

fldId - 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

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

Description copied from interface: FolderModule

Rename a folder in the repository.

Specified by:

rename in interface FolderModule

fldId - 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

public void move(String token,
        String fldId,
        String dstId)
          throws PathNotFoundException,
                 ItemExistsException,
                 AccessDeniedException,
                 RepositoryException,
                 DatabaseException

Description copied from interface: FolderModule

Move a folder to another location in the repository.

Specified by:

move in interface FolderModule

fldId - The path that identifies an unique folder.

dstId - 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

public void copy(String token,
        String fldId,
        String dstId)
          throws PathNotFoundException,
                 ItemExistsException,
                 AccessDeniedException,
                 RepositoryException,
                 IOException,
                 AutomationException,
                 DatabaseException,
                 UserQuotaExceededException

Description copied from interface: FolderModule

Copy a folder to another location in the repository.

Specified by:

copy in interface FolderModule

fldId - The path that identifies an unique folder.

dstId - 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

extendedCopy

public void extendedCopy(String token,
                String fldId,
                String dstId,
                ExtendedAttributes extAttr)
                  throws PathNotFoundException,
                         ItemExistsException,
                         AccessDeniedException,
                         RepositoryException,
                         IOException,
                         AutomationException,
                         DatabaseException,
                         UserQuotaExceededException

Description copied from interface: FolderModule

Copy a folder to another location in the repository.

Specified by:

extendedCopy in interface FolderModule

fldId - The path that identifies an unique folder.

dstId - The path of the destination folder.

extAttr - Attributes to define what need to be duplicated.

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
public List<Folder> getChilds(String token,
                                String fldId)
                       throws AccessDeniedException,
                              PathNotFoundException,
                              RepositoryException,
                              DatabaseException

Deprecated.

Description copied from interface: FolderModule

Retrieve a list of child folders from an existing one.

Specified by:

getChilds in interface FolderModule

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

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.

AccessDeniedException

DatabaseException

getChildren

public List<Folder> getChildren(String token,
                       String fldId)
                         throws AccessDeniedException,
                                PathNotFoundException,
                                RepositoryException,
                                DatabaseException

Description copied from interface: FolderModule

Retrieve a list of children folders from an existing one.

Specified by:

getChildren in interface FolderModule

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

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.

AccessDeniedException

DatabaseException

getContentInfo

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

Description copied from interface: FolderModule

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

Specified by:

getContentInfo in interface FolderModule

fldId - 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

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

Description copied from interface: FolderModule

Test if a folder path is valid.

Specified by:

isValid in interface FolderModule

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.

AccessDeniedException

DatabaseException

getPath

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

Description copied from interface: FolderModule

Get the folder path from a UUID

Specified by:

getPath in interface FolderModule

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

createMissingFolders

public void createMissingFolders(String token,
                        String fldPath)
                          throws RepositoryException,
                                 DatabaseException,
                                 PathNotFoundException,
                                 ItemExistsException,
                                 AccessDeniedException,
                                 ExtensionException,
                                 AutomationException

Create missing folders.

Throws:

RepositoryException

DatabaseException

PathNotFoundException

ItemExistsException

AccessDeniedException

ExtensionException

AutomationException