Interface DocumentService
- All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
- All Known Implementing Classes:
DocumentServiceImpl
@RemoteServiceRelativePath("document")
public interface DocumentService
extends com.google.gwt.user.client.rpc.RemoteService
The client side stub for the Document Service. This service allows r/w
operations on documents.
- Since:
- 6.0
- Author:
- Marco Meschieri - LogicalDOC
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addBookmarks
(List<Long> targetIds, int type) Adds new bookmarksaddDocuments
(boolean importZip, String charset, boolean immediateIndexing, GUIDocument metadata) addDocuments
(String language, long folderId, boolean importZip, String charset, boolean immediateIndexing, Long templateId) Adds new documents previously uploadedlong
Adds a new document note on the given documentvoid
applyParentFolderSecurity
(long docId) Applies all security settings from the folder to the documentvoid
archiveDocuments
(List<Long> docIds, String comment) Archives a set of documentslong
archiveFolder
(long folderId, String comment) Archives the documents in a folderbulkUpdate
(List<Long> ids, GUIDocument vo, boolean ignoreEmptyFields) Applies to a selection of documents all the given datacheckin
(GUIDocument document, boolean major) Checks-in a new document versioncheckinContent
(long docId, String content) Checks-in a new document's text contentvoid
Checks out the documentvoid
Cleans the uploaded files folderConverts a document in a given formatlong
countDocuments
(List<Long> folderIds, int status) Counts the documents in a given status contained the specified folder's treescreateDocument
(GUIDocument document, String content) Creates a new document with the given text contentcreateDownloadTicket
(long docId, int type, String suffix, Integer expireHours, Date expireDate, Integer maxDownloads, Integer maxViews) Creates a download ticketcreateWithContent
(GUIDocument vo, String content, boolean checkout) Creates a new empty documentvoid
deDuplicate
(Long folderId, boolean retainNewest) Convert duplicates with aliases, just one of the documents is maintainedvoid
Deletes a selection of documentsvoid
deleteBookmarks
(List<Long> bookmarkIds) Deletes a set of bookmarksvoid
deleteFromTrash
(List<Long> ids) Deletes a selection of documents from trashvoid
deleteLinks
(List<Long> ids) Deletes a selection of linksvoid
deleteNotes
(List<Long> ids) Deletes a selection of document notesdeleteRating
(long id) Deletes a votevoid
deleteTicket
(long ticketId) deleteVersions
(List<Long> ids) Deletes a selection of versionsvoid
destroyDocuments
(List<Long> ids) Permanently deletes a selection of documents, no restore will be possible latervoid
disableTicket
(long ticketId) void
Clear the user's trashvoid
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.extractEmail
(long docId, String fileVersion) Extracts the email representation from a .eml or .msg filegetAllowedPermissions
(List<Long> docIds) Gets the allowed permissions on a set of documents in regards of the current usergetById
(long docId) Retrieves a specific document by its IDgetContentAsString
(long docId) Retrieves the document's content as a stringgetNotes
(long docId, String fileVersion, Collection<String> types) Retrieves the notes of a documentgetRating
(long docId) Retrieves the rating of the given documentgetUserRating
(long docId) Retrieves the vote of the current user on the specified documentgetVersionsById
(long id1, long id2) Retrieves two specific versions by its IDvoid
indexDocuments
(List<Long> docIds) Indexes the given set of documentsvoid
linkDocuments
(List<Long> inDocIds, List<Long> outDocIds) Links a set of documentsvoid
Locks a set of documentsvoid
makeImmutable
(List<Long> docIds, String comment) Makes immutable a set of documentsvoid
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 indexablevoid
markUnindexable
(List<Long> docIds) Marks a set of documents as unindexableMerges a set of documents into a single PDFpromoteVersion
(long docId, String version) If you promote a prior version, what it does is make it the default version again.Renames the given documentreplaceAlias
(long aliasId) Replaces an alias with a copy of the original filevoid
replaceFile
(long docId, String fileVersion, String comment) Replaces the file associated to a given versionvoid
Restores a given documentsave
(GUIDocument document) Saves the document in the DBvoid
saveACL
(GUIDocument document) Applies all security settings to documentsaveEmailAttachment
(long docId, String fileVersion, String attachmentFileName) Extracts an email attachment and saves it in the same folder of the documentvoid
saveNotes
(long docId, String fileVersion, List<GUIDocumentNote> notes, Collection<String> types) Saves a set of notesint
saveRating
(GUIRating rating) Save a rating vote on a documentsendAsEmail
(GUIEmail email, String locale) Sends a document as email(attachment or download ticket)void
setPassword
(long docId, String password) Puts a password protection to the documentvoid
unarchiveDocuments
(List<Long> docIds) Restores a given set of archived documentsvoid
Unlocks a set of documentsboolean
Checks if the document can be accessed with the given passwordvoid
unsetPassword
(long docId, String password) Removes the password protection from the documentvoid
updateBookmark
(GUIBookmark bookmark) Updates a single bookmark's datavoid
updateLink
(long id, String type) Updates the links typevoid
updateNote
(long docId, long noteId, String fileVersion, String note) Updates a document note on the given documentint
updatePages
(long docId) Counts the pages of a document and updates the DB.void
validate
(GUIDocument document) Validates the metadata
-
Method Details
-
getById
Retrieves a specific document by its ID- Parameters:
docId
- identifier of the document- Returns:
- the document retrieved by the server application
- Throws:
ServerException
- an error happened in the server application
-
save
Saves the document in the DB- Parameters:
document
- The document to save- Returns:
- The saved document
- Throws:
ServerException
- an error happened in the server application
-
validate
Validates the metadata- Parameters:
document
- The document to validate- Throws:
ServerException
- in case of invalid instance, this exception contains the errors
-
rename
Renames the given document- Parameters:
documentId
- identifier of the documentsname
- the new document's filename- Returns:
- The updated document
- Throws:
ServerException
- an error happened in the server application
-
getVersionsById
Retrieves two specific versions by its ID- Parameters:
id1
- identifier of the first versionid2
- identifier of the second version- Returns:
- the two versions
- Throws:
ServerException
- an error happened in the server application
-
sendAsEmail
Sends a document as email(attachment or download ticket)- Parameters:
email
- the email to sendlocale
- the locale specification- Returns:
- "ok" otherwise an error code
- Throws:
ServerException
- an error happened in the server application
-
extractEmail
Extracts the email representation from a .eml or .msg file- Parameters:
docId
- the identifier of the mail documentfileVersion
- the File Version- Returns:
- the email representation
- Throws:
ServerException
- an error happened in the server application
-
saveEmailAttachment
GUIDocument saveEmailAttachment(long docId, String fileVersion, String attachmentFileName) throws ServerException Extracts an email attachment and saves it in the same folder of the document- Parameters:
docId
- the identifier of the mail documentfileVersion
- the File VersionattachmentFileName
- name of the attachment- Returns:
- the just created document
- Throws:
ServerException
- an error happened in the server application
-
updateLink
Updates the links type- Parameters:
id
- The link identifiertype
- The new type to be set- Throws:
ServerException
- an error happened in the server application
-
deleteLinks
Deletes a selection of links- Parameters:
ids
- identifiers of the links- Throws:
ServerException
- an error happened in the server application
-
deleteVersions
Deletes a selection of versions- Parameters:
ids
- identifiers of the versions- Returns:
- the document the deleted versions belongs to
- Throws:
ServerException
- an error happened in the server application
-
linkDocuments
Links a set of documents- Parameters:
inDocIds
- identifiers of the documents for the IN directionoutDocIds
- identifiers of the documents for the OUT direction- Throws:
ServerException
- an error happened in the server application
-
delete
Deletes a selection of documents- Parameters:
ids
- identifiers of the documents- Throws:
ServerException
- an error happened in the server application
-
destroyDocuments
Permanently deletes a selection of documents, no restore will be possible later- Parameters:
ids
- identifiers of the documents- Throws:
ServerException
- an error happened in the server application
-
deleteFromTrash
Deletes a selection of documents from trash- Parameters:
ids
- identifiers of documents- Throws:
ServerException
- an error happened in the server application
-
emptyTrash
Clear the user's trash- Throws:
ServerException
- an error happened in the server application
-
makeImmutable
Makes immutable a set of documents- Parameters:
docIds
- identifiers of the documentscomment
- the commit- Throws:
ServerException
- an error happened in the server application
-
archiveDocuments
Archives a set of documents- Parameters:
docIds
- identifiers of the documentscomment
- the commit- Throws:
ServerException
- an error happened in the server application
-
archiveFolder
Archives the documents in a folder- Parameters:
folderId
- identifier of the foldercomment
- a comment for the action- Returns:
- number of records added to the archive
- Throws:
ServerException
- an error happened in the server application
-
convert
Converts a document in a given format- Parameters:
docId
- identifier of the document to convertfileVersion
- version of the fileformat
- the format to convert to (e.g.: pdf, txt, ...- Returns:
- the converted document
- Throws:
ServerException
- an error happened in the server application
-
countDocuments
Counts the documents in a given status contained the specified folder's trees- Parameters:
folderIds
- identifiers of the foldersstatus
- a filter on the document's status- Returns:
- the count
- Throws:
ServerException
- an error happened in the server application
-
unlock
Unlocks a set of documents- Parameters:
docIds
- identifiers of the documents- Throws:
ServerException
- an error happened in the server application
-
lock
Locks a set of documents- Parameters:
docIds
- identifiers of the documentscomment
- the comment to the lock- Throws:
ServerException
- an error happened in the server application
-
checkout
Checks out the document- Parameters:
docIds
- identifiers of the documents- Throws:
ServerException
- an error happened in the server application
-
addDocuments
List<GUIDocument> addDocuments(String language, long folderId, boolean importZip, String charset, boolean immediateIndexing, Long templateId) throws ServerException Adds new documents previously uploaded- Parameters:
language
- The language applied to all documentsfolderId
- The destination folder identifierimportZip
- If .zip files have to be unpacked and the contained documents importedcharset
- Charset to use to process the .zip filesimmediateIndexing
- If the documents must be immediately indexedtemplateId
- The documents template- Returns:
- The list of created documents
- Throws:
ServerException
- an error happened in the server application
-
addDocuments
List<GUIDocument> addDocuments(boolean importZip, String charset, boolean immediateIndexing, GUIDocument metadata) throws ServerException - Throws:
ServerException
-
createDownloadTicket
List<String> createDownloadTicket(long docId, int type, String suffix, Integer expireHours, Date expireDate, Integer maxDownloads, Integer maxViews) throws ServerException Creates a download ticket- Parameters:
docId
- identifier of the documenttype
- the ticket type (0='download' 2='view')suffix
- the suffix(null or 'pdf')expireHours
- how many validity hoursexpireDate
- the exact expiration datemaxDownloads
- maximum number of allowed downloadsmaxViews
- 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
-
deleteTicket
- Throws:
ServerException
-
enableTicket
- Throws:
ServerException
-
disableTicket
- Throws:
ServerException
-
indexDocuments
Indexes the given set of documents- Parameters:
docIds
- The set of documents to index- Throws:
ServerException
- an error happened in the server application
-
checkin
Checks-in a new document version- Parameters:
document
- The document to updatemajor
- True if this is a major version- Returns:
- The updated document
- Throws:
ServerException
- an error happened in the server application
-
checkinContent
Checks-in a new document's text content- Parameters:
docId
- identifier of the documentcontent
- content of the file- Returns:
- the document
- Throws:
ServerException
- an error happened in the server application
-
replaceFile
Replaces the file associated to a given version- Parameters:
docId
- the identifier of the documentfileVersion
- the file versioncomment
- the comment- Throws:
ServerException
- an error happened in the server application
-
promoteVersion
If you promote a prior version, what it does is make it the default version again. (regardless of there being many versions)- Parameters:
docId
- the identifier of the documentversion
- version specification- Returns:
- the document
- Throws:
ServerException
- an error happened in the server application
-
createDocument
Creates a new document with the given text content- Parameters:
document
- the document to createcontent
- the contents- Returns:
- the created document
- Throws:
ServerException
- an error happened in the server application
-
getContentAsString
Retrieves the document's content as a string- Parameters:
docId
- identifier of the document- Returns:
- the document's extracted content
- Throws:
ServerException
- an error happened in the server application
-
restore
Restores a given document- Parameters:
docIds
- identifiers of the documentsfolderId
- identifier of the folder in which to restore the documents- Throws:
ServerException
- an error happened in the server application
-
unarchiveDocuments
Restores a given set of archived documents- Parameters:
docIds
- identifiers of the documents- Throws:
ServerException
- an error happened in the server application
-
addBookmarks
Adds new bookmarks- Parameters:
targetIds
- identfiers of the documents or folders to bookmarktype
- the type of bookmark (0 = document, 1 = folder)- Throws:
ServerException
- an error happened in the server application
-
deleteBookmarks
Deletes a set of bookmarks- Parameters:
bookmarkIds
- identifiers of the bookmarks to delete- Throws:
ServerException
- an error happened in the server application
-
updateBookmark
Updates a single bookmark's data- Parameters:
bookmark
- the bookmark to update- Throws:
ServerException
- an error happened in the server application
-
markHistoryAsRead
Marks as read the histories related to the current user and the given event.- Parameters:
event
- The history event to mark as read- Throws:
ServerException
- an error happened in the server application
-
markUnindexable
Marks a set of documents as unindexable- Parameters:
docIds
- identifiers of the documents- Throws:
ServerException
- an error happened in the server application
-
markIndexable
Marks a set of documents as indexable- Parameters:
docIds
- identifiers of the documentspolicy
- indexing policy:Constants.INDEX_TO_INDEX
orConstants.INDEX_TO_INDEX_METADATA
- Throws:
ServerException
- an error happened in the server application
-
cleanUploadedFileFolder
Cleans the uploaded files folder- Throws:
ServerException
- an error happened in the server application
-
getRating
Retrieves the rating of the given document- Parameters:
docId
- identifier of the document- Returns:
- the rating retrieved by the server application
- Throws:
ServerException
- an error happened in the server application
-
saveRating
Save a rating vote on a document- Parameters:
rating
- the document's rating- Returns:
- the new document rating value
- Throws:
ServerException
- an error happened in the server application
-
addNote
Adds a new document note on the given document- Parameters:
docId
- identifier of the documentnote
- the note's text- Returns:
- identifier of the created note
- Throws:
ServerException
- an error happened in the server application
-
updateNote
Updates a document note on the given document- Parameters:
docId
- identifier of the documentnoteId
- identifier of the notefileVersion
- file version to bind the note tonote
- text of the note- Throws:
ServerException
- an error happened in the server application
-
getNotes
List<GUIDocumentNote> getNotes(long docId, String fileVersion, Collection<String> types) throws ServerException Retrieves the notes of a document- Parameters:
docId
- identifier of the documentfileVersion
- file version specificationtypes
- optional filter for the note type- Returns:
- the notes on the given version
- Throws:
ServerException
- an error happened in the server application
-
saveNotes
void saveNotes(long docId, String fileVersion, List<GUIDocumentNote> notes, Collection<String> types) throws ServerException Saves a set of notes- Parameters:
docId
- identifier of the documentfileVersion
- optional file version all the notes are bound tonotes
- the notes to savetypes
- optional filter for the note type- Throws:
ServerException
- an error happened in the server application
-
deleteNotes
Deletes a selection of document notes- Parameters:
ids
- identifiers of the notes- Throws:
ServerException
- an error happened in the server application
-
bulkUpdate
List<GUIDocument> bulkUpdate(List<Long> ids, GUIDocument vo, boolean ignoreEmptyFields) throws ServerException Applies to a selection of documents all the given data- Parameters:
ids
- identifiers of the documents to updatevo
- the value object to use as templateignoreEmptyFields
- flag to skip fields empty in thevo
- Returns:
- the updated documents
- Throws:
ServerException
- an error happened in the server application
-
createWithContent
GUIDocument createWithContent(GUIDocument vo, String content, boolean checkout) throws ServerException Creates a new empty document- Parameters:
vo
- the value object to use as templatecontent
- the text body of the new documentcheckout
- if the new document must be checked out- Returns:
- the created document
- Throws:
ServerException
- an error happened in the server application
-
setPassword
Puts a password protection to the document- Parameters:
docId
- the identifier of the document to protectpassword
- the password to assign- Throws:
ServerException
- an error happened in the server application
-
unsetPassword
Removes the password protection from the document- Parameters:
docId
- the identifier of the document to unprotectpassword
- the password to clear- Throws:
ServerException
- an error happened in the server application
-
unprotect
Checks if the document can be accessed with the given password- Parameters:
docId
- the identifier of the document to unprotectpassword
- the password to clear- Returns:
- is the password is correct
- Throws:
ServerException
- an error happened in the server application
-
getUserRating
Retrieves the vote of the current user on the specified document- Parameters:
docId
- the identifier of the document- Returns:
- the rating
- Throws:
ServerException
- an error happened in the server application
-
deleteRating
Deletes a vote- Parameters:
id
- identifier of the rating to delete- Returns:
- the result
- Throws:
ServerException
- an error happened in the server application
-
replaceAlias
Replaces an alias with a copy of the original file- Parameters:
aliasId
- ID of the alias to replace- Returns:
- the just created document
- Throws:
ServerException
- an error happened in the server application
-
deDuplicate
Convert duplicates with aliases, just one of the documents is maintained- Parameters:
folderId
- optional ID of the folder to processretainNewest
- true if the newest has to be retained, otherwise it will be the oldest.- Throws:
ServerException
- an error happened in the server application
-
enforceFilesIntoFolderStorage
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.- Parameters:
folderId
- identifier of the tree root- Throws:
ServerException
- an error happened in the server application
-
merge
Merges a set of documents into a single PDF- Parameters:
docIds
- identifiers of the documents to mergetargetFolderId
- identifier of the folder that will receive the merged PDFfileName
- file name of the merged file- Returns:
- the newly created merged document
- Throws:
ServerException
- an error happened in the server application
-
updatePages
Counts the pages of a document and updates the DB.- Parameters:
docId
- identifier of the document- Returns:
- number of pages
- Throws:
ServerException
- an error happened in the server application
-
getAllowedPermissions
Gets the allowed permissions on a set of documents in regards of the current user- Parameters:
docIds
- collection of the documents- Throws:
ServerException
-
saveACL
Applies all security settings to document- Parameters:
document
- The document that will contain the new security settings- Throws:
ServerException
- an error happened in the server application
-
applyParentFolderSecurity
Applies all security settings from the folder to the document- Parameters:
docId
- The document that will contain the new security settings- Throws:
ServerException
- an error happened in the server application
-