org.opencrx.kernel.backend

Class Documents

java.lang.Object

org.opencrx.kernel.backend.AbstractImpl

org.opencrx.kernel.backend.Documents

public class Documents
extends AbstractImpl

Default documents backend class.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PRIVATE_DOCUMENTS_FOLDER_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Documents() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
MediaContent	addRevision(Document document, String contentName, String contentMimeType, String author, org.w3c.cci2.BinaryLargeObject content) Add revision to document.
int	countFilteredDocument(AbstractFilterDocument documentFilter) Count documents of given document filter.
DocumentFolderShare	createDefaultShare(DocumentFolder documentFolder) Create default document folder share for current user and folder.
Document	findDocument(String documentName, Segment segment) Find document.
DocumentFolder	findDocumentFolder(String documentFolderName, Segment segment) Find document folder.
Segment	getDocumentSegment(javax.jdo.PersistenceManager pm, String providerName, String segmentName) Get documents segment.
static Documents	getInstance() Get instance of registered document backend.
Document	initDocument(String documentName, String documentTitle, URL revisionURL, String revisionMimeType, String revisionName, DocumentFolder documentFolder, Segment segment, List<PrincipalGroup> allUsers) Create / update document.
DocumentFolder	initDocumentFolder(String documentFolderName, Segment segment, List<PrincipalGroup> allUsers) Create / update document folder.
static void	register() Register Documents backend class.
void	removeDefaultShare(DocumentFolder documentFolder) Remove / Deactivate default document folder share.

Methods inherited from class org.opencrx.kernel.backend.AbstractImpl

getInstance, getUidAsString, preDelete, preStore, registerImpl

Methods inherited from class java.lang.Object

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

Field Detail

PRIVATE_DOCUMENTS_FOLDER_SUFFIX

public static final String PRIVATE_DOCUMENTS_FOLDER_SUFFIX

See Also:

Constant Field Values

Constructor Detail

Documents

protected Documents()

Constructor.

Method Detail

register

public static void register()

Register Documents backend class.

getInstance

public static Documents getInstance()
                             throws org.openmdx.base.exception.ServiceException

Get instance of registered document backend.

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getDocumentSegment

public Segment getDocumentSegment(javax.jdo.PersistenceManager pm,
                         String providerName,
                         String segmentName)
                           throws org.openmdx.base.exception.ServiceException

Get documents segment.

Parameters:

pm -

providerName -

segmentName -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

findDocumentFolder

public DocumentFolder findDocumentFolder(String documentFolderName,
                                Segment segment)

Find document folder.

Parameters:

documentFolderName -

segment -

Returns:

initDocumentFolder

public DocumentFolder initDocumentFolder(String documentFolderName,
                                Segment segment,
                                List<PrincipalGroup> allUsers)

Create / update document folder.

Parameters:

documentFolderName -

segment -

allUsers -

Returns:

initDocument

public Document initDocument(String documentName,
                    String documentTitle,
                    URL revisionURL,
                    String revisionMimeType,
                    String revisionName,
                    DocumentFolder documentFolder,
                    Segment segment,
                    List<PrincipalGroup> allUsers)

Create / update document.

Parameters:

documentName -

documentTitle -

revisionURL -

revisionMimeType -

revisionName -

documentFolder -

segment -

allUsers -

Returns:

findDocument

public Document findDocument(String documentName,
                    Segment segment)

Find document.

Parameters:

documentName -

segment -

Returns:

countFilteredDocument

public int countFilteredDocument(AbstractFilterDocument documentFilter)
                          throws org.openmdx.base.exception.ServiceException

Count documents of given document filter.

Parameters:

documentFilter -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

addRevision

public MediaContent addRevision(Document document,
                       String contentName,
                       String contentMimeType,
                       String author,
                       org.w3c.cci2.BinaryLargeObject content)

Add revision to document.

Parameters:

document -

contentName -

contentMimeType -

author -

content -

createDefaultShare

public DocumentFolderShare createDefaultShare(DocumentFolder documentFolder)
                                       throws org.openmdx.base.exception.ServiceException

Create default document folder share for current user and folder.

Parameters:

documentFolder -

Throws:

org.openmdx.base.exception.ServiceException

removeDefaultShare

public void removeDefaultShare(DocumentFolder documentFolder)
                        throws org.openmdx.base.exception.ServiceException

Remove / Deactivate default document folder share.

Parameters:

documentFolder -

Throws:

org.openmdx.base.exception.ServiceException