com.openkm.module.db.base

Class BaseDocumentModule

java.lang.Object

com.openkm.module.db.base.BaseDocumentModule

public class BaseDocumentModule
extends Object

Constructor Summary

Constructors

Constructor and Description
BaseDocumentModule()

Method Summary

Methods

Modifier and Type	Method and Description
static NodeDocument	copy(String user, NodeDocument srcDocNode, String dstPath, NodeBase dstNode, String docName) Is invoked from DbDocumentNode and DbFolderNode.
static NodeDocument	create(String user, String parentPath, NodeBase parentNode, String name, String title, Calendar created, String mimeType, InputStream is, long size, Set<String> keywords, Set<String> categories, Ref<FileUploadResponse> fuResponse) Create a new document
static InputStream	getContent(String user, String docPath, boolean checkout, boolean extendedSecurity) Retrieve the content input stream from a document
static Document	getProperties(String user, NodeDocument nDocument) Get folder properties
static boolean	hasWorkflowNodes(String docUuid) Check if a node is being used in a running workflow

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseDocumentModule

public BaseDocumentModule()

Method Detail

create

public static NodeDocument create(String user,
                  String parentPath,
                  NodeBase parentNode,
                  String name,
                  String title,
                  Calendar created,
                  String mimeType,
                  InputStream is,
                  long size,
                  Set<String> keywords,
                  Set<String> categories,
                  Ref<FileUploadResponse> fuResponse)
                           throws PathNotFoundException,
                                  AccessDeniedException,
                                  ItemExistsException,
                                  UserQuotaExceededException,
                                  AutomationException,
                                  DatabaseException,
                                  IOException

Create a new document

Throws:

PathNotFoundException

AccessDeniedException

ItemExistsException

UserQuotaExceededException

AutomationException

DatabaseException

IOException

getProperties

public static Document getProperties(String user,
                     NodeDocument nDocument)
                              throws PathNotFoundException,
                                     DatabaseException

Get folder properties

Throws:

PathNotFoundException

DatabaseException

getContent

public static InputStream getContent(String user,
                     String docPath,
                     boolean checkout,
                     boolean extendedSecurity)
                              throws IOException,
                                     PathNotFoundException,
                                     AccessDeniedException,
                                     DatabaseException

Retrieve the content input stream from a document

Parameters:

user - The user who make the content petition.

docPath - Path of the document to get the content.

checkout - If the content is retrieved due to a checkout or not.

extendedSecurity - If the extended security DOWNLOAD permission should be evaluated. This is used to enable the document preview.

Throws:

IOException

PathNotFoundException

AccessDeniedException

DatabaseException

hasWorkflowNodes

public static boolean hasWorkflowNodes(String docUuid)
                                throws WorkflowException,
                                       PathNotFoundException,
                                       DatabaseException

Check if a node is being used in a running workflow

Throws:

WorkflowException

PathNotFoundException

DatabaseException

copy

public static NodeDocument copy(String user,
                NodeDocument srcDocNode,
                String dstPath,
                NodeBase dstNode,
                String docName)
                         throws PathNotFoundException,
                                AccessDeniedException,
                                ItemExistsException,
                                UserQuotaExceededException,
                                AutomationException,
                                DatabaseException,
                                IOException

Is invoked from DbDocumentNode and DbFolderNode.

Throws:

PathNotFoundException

AccessDeniedException

ItemExistsException

UserQuotaExceededException

AutomationException

DatabaseException

IOException