org.cyclos.services.contentmanagement

Interface DocumentService

All Superinterfaces:

CRUDService<DocumentDTO,DocumentData,DocumentDataParams>, Service

public interface DocumentService
extends CRUDService<DocumentDTO,DocumentData,DocumentDataParams>

Method Summary

Modifier and Type	Method and Description
DocumentVO	getDocument(DocumentVO document) Used to get the view only object of the document
RawFileVO	getDocumentFile(DocumentVO document) Return the file vo for a given document
DocumentSearchData	getDocumentSearchData(UserLocatorVO user) Returns data used to search documents, either over the given user or general documents
ProcessDynamicDocumentData	getProcessDynamicDocumentData(DocumentVO document, UserLocatorVO locator) Returns data used to fill a dynamic document based on the given user locator data
java.util.List<DocumentVO>	listMyDocuments() List all Documents filtered by user
java.lang.String	processDynamicDocument(ProcessDynamicDocumentDTO params) Processes the given document using the given user and custom field values
SerializableInputStream	readContent(DocumentVO document) Reads the contents of the document
void	saveFile(DocumentVO document, java.lang.String contentType, java.lang.String fileName, SerializableInputStream contents) Saves the given document, returning the generated identifier
Page<DocumentVO>	search(DocumentQuery query) List all documents filtered by category

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

getDocument

DocumentVO getDocument(@NotNull
                       DocumentVO document)
                throws FrameworkException

Used to get the view only object of the document

Throws:

FrameworkException

getDocumentFile

RawFileVO getDocumentFile(@NotNull
                          DocumentVO document)
                   throws FrameworkException

Return the file vo for a given document

Throws:

FrameworkException

getDocumentSearchData

DocumentSearchData getDocumentSearchData(UserLocatorVO user)
                                  throws FrameworkException

Returns data used to search documents, either over the given user or general documents

Throws:

FrameworkException

getProcessDynamicDocumentData

ProcessDynamicDocumentData getProcessDynamicDocumentData(@NotNull
                                                         DocumentVO document,
                                                         UserLocatorVO locator)
                                                  throws FrameworkException

Returns data used to fill a dynamic document based on the given user locator data

Throws:

FrameworkException

listMyDocuments

java.util.List<DocumentVO> listMyDocuments()
                                    throws FrameworkException

List all Documents filtered by user

Throws:

FrameworkException

processDynamicDocument

java.lang.String processDynamicDocument(@NotNull
                                        ProcessDynamicDocumentDTO params)
                                 throws FrameworkException

Processes the given document using the given user and custom field values

Throws:

FrameworkException

readContent

SerializableInputStream readContent(@NotNull
                                    DocumentVO document)
                             throws FrameworkException

Reads the contents of the document

Throws:

EntityNotFoundException - When the image is not found

FrameworkException

saveFile

void saveFile(@NotNull
              DocumentVO document,
              java.lang.String contentType,
              java.lang.String fileName,
              SerializableInputStream contents)
       throws FrameworkException

Saves the given document, returning the generated identifier

Throws:

FrameworkException

search

Page<DocumentVO> search(@NotNull
                        DocumentQuery query)
                 throws FrameworkException

List all documents filtered by category

Throws:

FrameworkException