Package com.logicaldoc.web.service

Class DocumentServiceImpl

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

com.google.gwt.user.server.rpc.RemoteServiceServlet

com.logicaldoc.web.service.AbstractRemoteService

com.logicaldoc.web.service.DocumentServiceImpl

All Implemented Interfaces:

com.google.gwt.user.client.rpc.RemoteService, com.google.gwt.user.server.rpc.SerializationPolicyProvider, DocumentService, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class DocumentServiceImpl
extends AbstractRemoteService
implements DocumentService

The document service for the operations on the documents done through the GUI.

Since:

6.0

Author:

Marco Meschieri - LogicalDOC

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.logicaldoc.gui.frontend.client.services.DocumentService

DocumentService.Instance

Constructor Summary

Constructors

Constructor	Description
DocumentServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	addBookmarks(List<Long> ids, int type)	Adds new bookmarks
List<GUIDocument>	addDocuments(boolean importZip, String charset, boolean immediateIndexing, GUIDocument metadata)
List<GUIDocument>	addDocuments(String language, long folderId, boolean importZip, String charset, boolean immediateIndexing, Long templateId)	Adds new documents previously uploaded
long	addNote(long docId, String message)	Adds a new document note on the given document
void	applyParentFolderSecurity(long docId)	Applies all security settings from the folder to the document
void	archiveDocuments(List<Long> docIds, String comment)	Archives a set of documents
long	archiveFolder(long folderId, String comment)	Archives the documents in a folder
List<GUIDocument>	bulkUpdate(List<Long> ids, GUIDocument vo, boolean ignoreEmptyFields)	Applies to a selection of documents all the given data
GUIDocument	checkin(GUIDocument document, boolean major)	Checks-in a new document version
GUIDocument	checkinContent(long docId, String content)	Checks-in a new document's text content
void	checkout(List<Long> docIds)	Checks out the document
void	cleanUploadedFileFolder()	Cleans the uploaded files folder
GUIDocument	convert(long docId, String fileVersion, String format)	Converts a document in a given format
long	countDocuments(List<Long> folderIds, int status)	Counts the documents in a given status contained the specified folder's trees
GUIDocument	createDocument(GUIDocument document, String content)	Creates a new document with the given text content
List<String>	createDownloadTicket(long docId, int type, String suffix, Integer expireHours, Date expireDate, Integer maxDownloads, Integer maxViews)	Creates a download ticket
GUIDocument	createWithContent(GUIDocument vo, String content, boolean checkout)	Creates a new empty document
void	deDuplicate(Long folderId, boolean retainNewest)	Convert duplicates with aliases, just one of the documents is maintained
void	delete(List<Long> ids)	Deletes a selection of documents
void	deleteBookmarks(List<Long> bookmarkIds)	Deletes a set of bookmarks
void	deleteFromTrash(List<Long> ids)	Deletes a selection of documents from trash
void	deleteLinks(List<Long> ids)	Deletes a selection of links
void	deleteNotes(List<Long> ids)	Deletes a selection of document notes
Integer	deleteRating(long id)	Deletes a vote
void	deleteTicket(long ticketId)
GUIDocument	deleteVersions(List<Long> ids)	Deletes a selection of versions
void	disableTicket(long ticketId)
void	emptyTrash()	Clear the user's trash
void	enableTicket(long ticketId)
void	enforceFilesIntoFolderStorage(long folderId)	Enforces that all the files in the given tree are stored in the storage configured in the owning folder.
GUIEmail	extractEmail(long docId, String fileVersion)	Extracts the email representation from a .eml or .msg file
GUIDocument	fromDocument(Document doc, GUIFolder folder, User sessionUser)
GUIDocument	getById(long docId)	Retrieves a specific document by its ID
String	getContentAsString(long docId)	Retrieves the document's content as a string
GUIDocument	getDocument(Session session, long docId)
GUIAccessControlEntry	getEnabledPermissions(List<Long> docIds)	Gets the shared permissions on a set of documents in regards of the current user
List<GUIDocumentNote>	getNotes(long docId, String fileVersion, Collection<String> types)	Retrieves the notes of a document
GUIRating	getRating(long docId)	Retrieves the rating of the given document
GUIRating	getUserRating(long docId)	Retrieves the vote of the current user on the specified document
List<GUIVersion>	getVersionsById(long id1, long id2)	Retrieves two specific versions by its ID
void	indexDocuments(List<Long> docIds)	Indexes the given set of documents
void	linkDocuments(List<Long> inDocIds, List<Long> outDocIds)	Links a set of documents
void	lock(List<Long> docIds, String comment)	Locks a set of documents
void	makeImmutable(List<Long> docIds, String comment)	Makes immutable a set of documents
void	markHistoryAsRead(String event)	Marks as read the histories related to the current user and the given event.
void	markIndexable(List<Long> docIds, int policy)	Marks a set of documents as indexable
void	markUnindexable(List<Long> docIds)	Marks a set of documents as unindexable
GUIDocument	merge(List<Long> docIds, long targetFolderId, String fileName)	Merges a set of documents into a single PDF
GUIDocument	promoteVersion(long docId, String version)	If you promote a prior version, what it does is make it the default version again.
GUIDocument	rename(long documentId, String name)	Renames the given document
GUIDocument	replaceAlias(long aliasId)	Replaces an alias with a copy of the original file
void	replaceFile(long docId, String fileVersion, String comment)	Replaces the file associated to a given version
void	restore(List<Long> docIds, long folderId)	Restores a given document
GUIDocument	save(GUIDocument guiDocument)	Saves the document in the DB
void	saveACL(GUIDocument guiDocument)	Applies all security settings to document
GUIDocument	saveEmailAttachment(long docId, String fileVersion, String attachmentFileName)	Extracts an email attachment and saves it in the same folder of the document
void	saveNotes(long docId, List<GUIDocumentNote> notes, Collection<String> types)	Saves a set of notes
int	saveRating(GUIRating rating)	Save a rating vote on a document
String	sendAsEmail(GUIEmail guiMail, String locale)	Sends a document as email(attachment or download ticket)
void	setPassword(long docId, String password)	Puts a password protection to the document
static Document	toDocument(GUIDocument guiDocument)	Produces a plain new Document from a GUIDocument
void	unarchiveDocuments(List<Long> docIds)	Restores a given set of archived documents
void	unlock(List<Long> docIds)	Unlocks a set of documents
boolean	unprotect(long docId, String password)	Checks if the document can be accessed with the given password
void	unsetPassword(long docId, String currentPassword)	Removes the password protection from the document
void	updateBookmark(GUIBookmark bookmark)	Updates a single bookmark's data
void	updateLink(long id, String type)	Updates the links type
void	updateNote(long docId, long noteId, String message)	Updates a document note on the given document
int	updatePages(long docId)	Counts the pages of a document and updates the DB.
void	validate(GUIDocument document)	Validates the metadata

Methods inherited from class com.google.gwt.user.server.rpc.RemoteServiceServlet

getSerializationPolicy, init, processCall, processCall, processPost

Methods inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

doPost

Methods inherited from class javax.servlet.http.HttpServlet

service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentServiceImpl

public DocumentServiceImpl()

Method Details

addBookmarks

public void addBookmarks(List<Long> ids,
 int type)
                  throws ServerException

Description copied from interface: DocumentService

Adds new bookmarks

Specified by:

addBookmarks in interface DocumentService

Parameters:

ids - identfiers of the documents or folders to bookmark

type - the type of bookmark (0 = document, 1 = folder)

Throws:

ServerException - an error happened in the server application

indexDocuments

public void indexDocuments(List<Long> docIds)
                    throws ServerException

Description copied from interface: DocumentService

Indexes the given set of documents

Specified by:

indexDocuments in interface DocumentService

Parameters:

docIds - The set of documents to index

Throws:

ServerException - an error happened in the server application

addDocuments

public List<GUIDocument> addDocuments(boolean importZip,
 String charset,
 boolean immediateIndexing,
 GUIDocument metadata)
                               throws ServerException

Specified by:

addDocuments in interface DocumentService

Throws:

ServerException

checkin

public GUIDocument checkin(GUIDocument document,
 boolean major)
                    throws ServerException

Description copied from interface: DocumentService

Checks-in a new document version

Specified by:

checkin in interface DocumentService

Parameters:

document - The document to update

major - True if this is a major version

Returns:

The updated document

Throws:

ServerException - an error happened in the server application

addDocuments

public List<GUIDocument> addDocuments(String language,
 long folderId,
 boolean importZip,
 String charset,
 boolean immediateIndexing,
 Long templateId)
                               throws ServerException

Description copied from interface: DocumentService

Adds new documents previously uploaded

Specified by:

addDocuments in interface DocumentService

Parameters:

language - The language applied to all documents

folderId - The destination folder identifier

importZip - If .zip files have to be unpacked and the contained documents imported

charset - Charset to use to process the .zip files

immediateIndexing - If the documents must be immediately indexed

templateId - The documents template

Returns:

The list of created documents

Throws:

ServerException - an error happened in the server application

promoteVersion

public GUIDocument promoteVersion(long docId,
 String version)
                           throws ServerException

Description copied from interface: DocumentService

If you promote a prior version, what it does is make it the default version again. (regardless of there being many versions)

Specified by:

promoteVersion in interface DocumentService

Parameters:

docId - the identifier of the document

version - version specification

Returns:

the document

Throws:

ServerException - an error happened in the server application

checkout

public void checkout(List<Long> docIds)
              throws ServerException

Description copied from interface: DocumentService

Checks out the document

Specified by:

checkout in interface DocumentService

Parameters:

docIds - identifiers of the documents

Throws:

ServerException - an error happened in the server application

lock

public void lock(List<Long> docIds,
 String comment)
          throws ServerException

Description copied from interface: DocumentService

Locks a set of documents

Specified by:

lock in interface DocumentService

Parameters:

docIds - identifiers of the documents

comment - the comment to the lock

Throws:

ServerException - an error happened in the server application

delete

public void delete(List<Long> ids)
            throws ServerException

Description copied from interface: DocumentService

Deletes a selection of documents

Specified by:

delete in interface DocumentService

Parameters:

ids - identifiers of the documents

Throws:

ServerException - an error happened in the server application

deleteBookmarks

public void deleteBookmarks(List<Long> bookmarkIds)
                     throws ServerException

Description copied from interface: DocumentService

Deletes a set of bookmarks

Specified by:

deleteBookmarks in interface DocumentService

Parameters:

bookmarkIds - identifiers of the bookmarks to delete

Throws:

ServerException - an error happened in the server application

deleteLinks

public void deleteLinks(List<Long> ids)
                 throws ServerException

Description copied from interface: DocumentService

Deletes a selection of links

Specified by:

deleteLinks in interface DocumentService

Parameters:

ids - identifiers of the links

Throws:

ServerException - an error happened in the server application

getById

public GUIDocument getById(long docId)
                    throws ServerException

Description copied from interface: DocumentService

Retrieves a specific document by its ID

Specified by:

getById in interface DocumentService

Parameters:

docId - identifier of the document

Returns:

the document retrieved by the server application

Throws:

ServerException - an error happened in the server application

getDocument

public GUIDocument getDocument(Session session,
 long docId)
                        throws InvalidSessionServerException,
PersistenceException,
PermissionException

Throws:

InvalidSessionServerException

PersistenceException

PermissionException

fromDocument

public GUIDocument fromDocument(Document doc,
 GUIFolder folder,
 User sessionUser)
                         throws PersistenceException

Throws:

PersistenceException

getVersionsById

public List<GUIVersion> getVersionsById(long id1,
 long id2)
                                 throws ServerException

Description copied from interface: DocumentService

Retrieves two specific versions by its ID

Specified by:

getVersionsById in interface DocumentService

Parameters:

id1 - identifier of the first version

id2 - identifier of the second version

Returns:

the two versions

Throws:

ServerException - an error happened in the server application

linkDocuments

public void linkDocuments(List<Long> inDocIds,
 List<Long> outDocIds)
                   throws ServerException

Description copied from interface: DocumentService

Links a set of documents

Specified by:

linkDocuments in interface DocumentService

Parameters:

inDocIds - identifiers of the documents for the IN direction

outDocIds - identifiers of the documents for the OUT direction

Throws:

ServerException - an error happened in the server application

makeImmutable

public void makeImmutable(List<Long> docIds,
 String comment)
                   throws ServerException

Description copied from interface: DocumentService

Makes immutable a set of documents

Specified by:

makeImmutable in interface DocumentService

Parameters:

docIds - identifiers of the documents

comment - the commit

Throws:

ServerException - an error happened in the server application

markHistoryAsRead

public void markHistoryAsRead(String event)
                       throws ServerException

Description copied from interface: DocumentService

Marks as read the histories related to the current user and the given event.

Specified by:

markHistoryAsRead in interface DocumentService

Parameters:

event - The history event to mark as read

Throws:

ServerException - an error happened in the server application

markIndexable

public void markIndexable(List<Long> docIds,
 int policy)
                   throws ServerException

Description copied from interface: DocumentService

Marks a set of documents as indexable

Specified by:

markIndexable in interface DocumentService

Parameters:

docIds - identifiers of the documents

policy - indexing policy: Constants.INDEX_TO_INDEX or Constants.INDEX_TO_INDEX_METADATA

Throws:

ServerException - an error happened in the server application

markUnindexable

public void markUnindexable(List<Long> docIds)
                     throws ServerException

Description copied from interface: DocumentService

Marks a set of documents as unindexable

Specified by:

markUnindexable in interface DocumentService

Parameters:

docIds - identifiers of the documents

Throws:

ServerException - an error happened in the server application

restore

public void restore(List<Long> docIds,
 long folderId)
             throws ServerException

Description copied from interface: DocumentService

Restores a given document

Specified by:

restore in interface DocumentService

Parameters:

docIds - identifiers of the documents

folderId - identifier of the folder in which to restore the documents

Throws:

ServerException - an error happened in the server application

validate

public void validate(GUIDocument document)
              throws ServerException

Description copied from interface: DocumentService

Validates the metadata

Specified by:

validate in interface DocumentService

Parameters:

document - The document to validate

Throws:

ServerException - in case of invalid instance, this exception contains the errors

save

public GUIDocument save(GUIDocument guiDocument)
                 throws ServerException

Description copied from interface: DocumentService

Saves the document in the DB

Specified by:

save in interface DocumentService

Parameters:

guiDocument - The document to save

Returns:

The saved document

Throws:

ServerException - an error happened in the server application

toDocument

public static Document toDocument(GUIDocument guiDocument)
                           throws PersistenceException

Produces a plain new Document from a GUIDocument

Parameters:

guiDocument - the GUI document

Returns:

the core Document

Throws:

PersistenceException - error at data layer

sendAsEmail

public String sendAsEmail(GUIEmail guiMail,
 String locale)
                   throws ServerException

Description copied from interface: DocumentService

Sends a document as email(attachment or download ticket)

Specified by:

sendAsEmail in interface DocumentService

Parameters:

guiMail - the email to send

locale - the locale specification

Returns:

"ok" otherwise an error code

Throws:

ServerException - an error happened in the server application

unlock

public void unlock(List<Long> docIds)
            throws ServerException

Description copied from interface: DocumentService

Unlocks a set of documents

Specified by:

unlock in interface DocumentService

Parameters:

docIds - identifiers of the documents

Throws:

ServerException - an error happened in the server application

updateBookmark

public void updateBookmark(GUIBookmark bookmark)
                    throws ServerException

Description copied from interface: DocumentService

Updates a single bookmark's data

Specified by:

updateBookmark in interface DocumentService

Parameters:

bookmark - the bookmark to update

Throws:

ServerException - an error happened in the server application

updateLink

public void updateLink(long id,
 String type)
                throws ServerException

Description copied from interface: DocumentService

Updates the links type

Specified by:

updateLink in interface DocumentService

Parameters:

id - The link identifier

type - The new type to be set

Throws:

ServerException - an error happened in the server application

cleanUploadedFileFolder

public void cleanUploadedFileFolder()
                             throws ServerException

Description copied from interface: DocumentService

Cleans the uploaded files folder

Specified by:

cleanUploadedFileFolder in interface DocumentService

Throws:

ServerException - an error happened in the server application

getRating

public GUIRating getRating(long docId)
                    throws ServerException

Description copied from interface: DocumentService

Retrieves the rating of the given document

Specified by:

getRating in interface DocumentService

Parameters:

docId - identifier of the document

Returns:

the rating retrieved by the server application

Throws:

ServerException - an error happened in the server application

saveRating

public int saveRating(GUIRating rating)
               throws ServerException

Description copied from interface: DocumentService

Save a rating vote on a document

Specified by:

saveRating in interface DocumentService

Parameters:

rating - the document's rating

Returns:

the new document rating value

Throws:

ServerException - an error happened in the server application

addNote

public long addNote(long docId,
 String message)
             throws ServerException

Description copied from interface: DocumentService

Adds a new document note on the given document

Specified by:

addNote in interface DocumentService

Parameters:

docId - identifier of the document

message - the note's text

Returns:

identifier of the created note

Throws:

ServerException - an error happened in the server application

getNotes

public List<GUIDocumentNote> getNotes(long docId,
 String fileVersion,
 Collection<String> types)
                               throws ServerException

Description copied from interface: DocumentService

Retrieves the notes of a document

Specified by:

getNotes in interface DocumentService

Parameters:

docId - identifier of the document

fileVersion - file version specification

types - optional filter for the note type

Returns:

the notes on the given version

Throws:

ServerException - an error happened in the server application

saveNotes

public void saveNotes(long docId,
 List<GUIDocumentNote> notes,
 Collection<String> types)
               throws ServerException

Description copied from interface: DocumentService

Saves a set of notes

Specified by:

saveNotes in interface DocumentService

Parameters:

docId - identifier of the document

notes - the notes to save

types - optional filter for the note type

Throws:

ServerException - an error happened in the server application

deleteNotes

public void deleteNotes(List<Long> ids)
                 throws ServerException

Description copied from interface: DocumentService

Deletes a selection of document notes

Specified by:

deleteNotes in interface DocumentService

Parameters:

ids - identifiers of the notes

Throws:

ServerException - an error happened in the server application

bulkUpdate

public List<GUIDocument> bulkUpdate(List<Long> ids,
 GUIDocument vo,
 boolean ignoreEmptyFields)
                             throws ServerException

Description copied from interface: DocumentService

Applies to a selection of documents all the given data

Specified by:

bulkUpdate in interface DocumentService

Parameters:

ids - identifiers of the documents to update

vo - the value object to use as template

ignoreEmptyFields - flag to skip fields empty in the vo

Returns:

the updated documents

Throws:

ServerException - an error happened in the server application

updateNote

public void updateNote(long docId,
 long noteId,
 String message)
                throws ServerException

Description copied from interface: DocumentService

Updates a document note on the given document

Specified by:

updateNote in interface DocumentService

Parameters:

docId - identifier of the document

noteId - identifier of the note

message - text of the note

Throws:

ServerException - an error happened in the server application

deleteVersions

public GUIDocument deleteVersions(List<Long> ids)
                           throws ServerException

Description copied from interface: DocumentService

Deletes a selection of versions

Specified by:

deleteVersions in interface DocumentService

Parameters:

ids - identifiers of the versions

Returns:

the document the deleted versions belongs to

Throws:

ServerException - an error happened in the server application

createWithContent

public GUIDocument createWithContent(GUIDocument vo,
 String content,
 boolean checkout)
                              throws ServerException

Description copied from interface: DocumentService

Creates a new empty document

Specified by:

createWithContent in interface DocumentService

Parameters:

vo - the value object to use as template

content - the text body of the new document

checkout - if the new document must be checked out

Returns:

the created document

Throws:

ServerException - an error happened in the server application

deleteFromTrash

public void deleteFromTrash(List<Long> ids)
                     throws ServerException

Description copied from interface: DocumentService

Deletes a selection of documents from trash

Specified by:

deleteFromTrash in interface DocumentService

Parameters:

ids - identifiers of documents

Throws:

ServerException - an error happened in the server application

emptyTrash

public void emptyTrash()
                throws ServerException

Description copied from interface: DocumentService

Clear the user's trash

Specified by:

emptyTrash in interface DocumentService

Throws:

ServerException - an error happened in the server application

archiveDocuments

public void archiveDocuments(List<Long> docIds,
 String comment)
                      throws ServerException

Description copied from interface: DocumentService

Archives a set of documents

Specified by:

archiveDocuments in interface DocumentService

Parameters:

docIds - identifiers of the documents

comment - the commit

Throws:

ServerException - an error happened in the server application

archiveFolder

public long archiveFolder(long folderId,
 String comment)
                   throws ServerException

Description copied from interface: DocumentService

Archives the documents in a folder

Specified by:

archiveFolder in interface DocumentService

Parameters:

folderId - identifier of the folder

comment - a comment for the action

Returns:

number of records added to the archive

Throws:

ServerException - an error happened in the server application

unarchiveDocuments

public void unarchiveDocuments(List<Long> docIds)
                        throws ServerException

Description copied from interface: DocumentService

Restores a given set of archived documents

Specified by:

unarchiveDocuments in interface DocumentService

Parameters:

docIds - identifiers of the documents

Throws:

ServerException - an error happened in the server application

countDocuments

public long countDocuments(List<Long> folderIds,
 int status)
                    throws ServerException

Description copied from interface: DocumentService

Counts the documents in a given status contained the specified folder's trees

Specified by:

countDocuments in interface DocumentService

Parameters:

folderIds - identifiers of the folders

status - a filter on the document's status

Returns:

the count

Throws:

ServerException - an error happened in the server application

createDownloadTicket

public List<String> createDownloadTicket(long docId,
 int type,
 String suffix,
 Integer expireHours,
 Date expireDate,
 Integer maxDownloads,
 Integer maxViews)
                                  throws ServerException

Description copied from interface: DocumentService

Creates a download ticket

Specified by:

createDownloadTicket in interface DocumentService

Parameters:

docId - identifier of the document

type - the ticket type (0='download' 2='view')

suffix - the suffix(null or 'pdf')

expireHours - how many validity hours

expireDate - the exact expiration date

maxDownloads - maximum number of allowed downloads

maxViews - maximum number of allowed views

Returns:

the generated ticket ID, a sample URL using the browser's URL, a sample URL using the server.url setting

Throws:

ServerException - an error happened in the server application

setPassword

public void setPassword(long docId,
 String password)
                 throws ServerException

Description copied from interface: DocumentService

Puts a password protection to the document

Specified by:

setPassword in interface DocumentService

Parameters:

docId - the identifier of the document to protect

password - the password to assign

Throws:

ServerException - an error happened in the server application

unsetPassword

public void unsetPassword(long docId,
 String currentPassword)
                   throws ServerException

Description copied from interface: DocumentService

Removes the password protection from the document

Specified by:

unsetPassword in interface DocumentService

Parameters:

docId - the identifier of the document to unprotect

currentPassword - the password to clear

Throws:

ServerException - an error happened in the server application

unprotect

public boolean unprotect(long docId,
 String password)
                  throws ServerException

Description copied from interface: DocumentService

Checks if the document can be accessed with the given password

Specified by:

unprotect in interface DocumentService

Parameters:

docId - the identifier of the document to unprotect

password - the password to clear

Returns:

is the password is correct

Throws:

ServerException - an error happened in the server application

getContentAsString

public String getContentAsString(long docId)
                          throws ServerException

Description copied from interface: DocumentService

Retrieves the document's content as a string

Specified by:

getContentAsString in interface DocumentService

Parameters:

docId - identifier of the document

Returns:

the document's extracted content

Throws:

ServerException - an error happened in the server application

checkinContent

public GUIDocument checkinContent(long docId,
 String content)
                           throws ServerException

Description copied from interface: DocumentService

Checks-in a new document's text content

Specified by:

checkinContent in interface DocumentService

Parameters:

docId - identifier of the document

content - content of the file

Returns:

the document

Throws:

ServerException - an error happened in the server application

replaceFile

public void replaceFile(long docId,
 String fileVersion,
 String comment)
                 throws ServerException

Description copied from interface: DocumentService

Replaces the file associated to a given version

Specified by:

replaceFile in interface DocumentService

Parameters:

docId - the identifier of the document

fileVersion - the file version

comment - the comment

Throws:

ServerException - an error happened in the server application

createDocument

public GUIDocument createDocument(GUIDocument document,
 String content)
                           throws ServerException

Description copied from interface: DocumentService

Creates a new document with the given text content

Specified by:

createDocument in interface DocumentService

Parameters:

document - the document to create

content - the contents

Returns:

the created document

Throws:

ServerException - an error happened in the server application

getUserRating

public GUIRating getUserRating(long docId)
                        throws ServerException

Description copied from interface: DocumentService

Retrieves the vote of the current user on the specified document

Specified by:

getUserRating in interface DocumentService

Parameters:

docId - the identifier of the document

Returns:

the rating

Throws:

ServerException - an error happened in the server application

deleteRating

public Integer deleteRating(long id)
                     throws ServerException

Description copied from interface: DocumentService

Deletes a vote

Specified by:

deleteRating in interface DocumentService

Parameters:

id - identifier of the rating to delete

Returns:

the result

Throws:

ServerException - an error happened in the server application

convert

public GUIDocument convert(long docId,
 String fileVersion,
 String format)
                    throws ServerException

Description copied from interface: DocumentService

Converts a document in a given format

Specified by:

convert in interface DocumentService

Parameters:

docId - identifier of the document to convert

fileVersion - version of the file

format - the format to convert to (e.g.: pdf, txt, ...

Returns:

the converted document

Throws:

ServerException - an error happened in the server application

extractEmail

public GUIEmail extractEmail(long docId,
 String fileVersion)
                      throws ServerException

Description copied from interface: DocumentService

Extracts the email representation from a .eml or .msg file

Specified by:

extractEmail in interface DocumentService

Parameters:

docId - the identifier of the mail document

fileVersion - the File Version

Returns:

the email representation

Throws:

ServerException - an error happened in the server application

saveEmailAttachment

public GUIDocument saveEmailAttachment(long docId,
 String fileVersion,
 String attachmentFileName)
                                throws ServerException

Description copied from interface: DocumentService

Extracts an email attachment and saves it in the same folder of the document

Specified by:

saveEmailAttachment in interface DocumentService

Parameters:

docId - the identifier of the mail document

fileVersion - the File Version

attachmentFileName - name of the attachment

Returns:

the just created document

Throws:

ServerException - an error happened in the server application

replaceAlias

public GUIDocument replaceAlias(long aliasId)
                         throws ServerException

Description copied from interface: DocumentService

Replaces an alias with a copy of the original file

Specified by:

replaceAlias in interface DocumentService

Parameters:

aliasId - ID of the alias to replace

Returns:

the just created document

Throws:

ServerException - an error happened in the server application

deDuplicate

public void deDuplicate(Long folderId,
 boolean retainNewest)
                 throws ServerException

Description copied from interface: DocumentService

Convert duplicates with aliases, just one of the documents is maintained

Specified by:

deDuplicate in interface DocumentService

Parameters:

folderId - optional ID of the folder to process

retainNewest - true if the newest has to be retained, otherwise it will be the oldest.

Throws:

ServerException - an error happened in the server application

deleteTicket

public void deleteTicket(long ticketId)
                  throws ServerException

Specified by:

deleteTicket in interface DocumentService

Throws:

ServerException

enableTicket

public void enableTicket(long ticketId)
                  throws ServerException

Specified by:

enableTicket in interface DocumentService

Throws:

ServerException

disableTicket

public void disableTicket(long ticketId)
                   throws ServerException

Specified by:

disableTicket in interface DocumentService

Throws:

ServerException

enforceFilesIntoFolderStorage

public void enforceFilesIntoFolderStorage(long folderId)
                                   throws ServerException

Description copied from interface: DocumentService

Enforces that all the files in the given tree are stored in the storage configured in the owning folder. The process is asynchronous, at the end an internal message to the user will be sent to alert him about its end.

Specified by:

enforceFilesIntoFolderStorage in interface DocumentService

Parameters:

folderId - identifier of the tree root

Throws:

ServerException - an error happened in the server application

merge

public GUIDocument merge(List<Long> docIds,
 long targetFolderId,
 String fileName)
                  throws ServerException

Description copied from interface: DocumentService

Merges a set of documents into a single PDF

Specified by:

merge in interface DocumentService

Parameters:

docIds - identifiers of the documents to merge

targetFolderId - identifier of the folder that will receive the merged PDF

fileName - file name of the merged file

Returns:

the newly created merged document

Throws:

ServerException - an error happened in the server application

updatePages

public int updatePages(long docId)
                throws ServerException

Description copied from interface: DocumentService

Counts the pages of a document and updates the DB.

Specified by:

updatePages in interface DocumentService

Parameters:

docId - identifier of the document

Returns:

number of pages

Throws:

ServerException - an error happened in the server application

rename

public GUIDocument rename(long documentId,
 String name)
                   throws ServerException

Description copied from interface: DocumentService

Renames the given document

Specified by:

rename in interface DocumentService

Parameters:

documentId - identifier of the documents

name - the new document's filename

Returns:

The updated document

Throws:

ServerException - an error happened in the server application

saveACL

public void saveACL(GUIDocument guiDocument)
             throws ServerException

Description copied from interface: DocumentService

Applies all security settings to document

Specified by:

saveACL in interface DocumentService

Parameters:

guiDocument - The document that will contain the new security settings

Throws:

ServerException - an error happened in the server application

applyParentFolderSecurity

public void applyParentFolderSecurity(long docId)
                               throws ServerException

Description copied from interface: DocumentService

Applies all security settings from the folder to the document

Specified by:

applyParentFolderSecurity in interface DocumentService

Parameters:

docId - The document that will contain the new security settings

Throws:

ServerException - an error happened in the server application

getEnabledPermissions

public GUIAccessControlEntry getEnabledPermissions(List<Long> docIds)
                                            throws ServerException

Description copied from interface: DocumentService

Gets the shared permissions on a set of documents in regards of the current user

Specified by:

getEnabledPermissions in interface DocumentService

Parameters:

docIds - collection of the documents

Throws:

ServerException