com.logicaldoc.gui.frontend.client.services

Interface DocumentService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

DocumentServiceImpl

@RemoteServiceRelativePath(value="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 - Logical Objects

Method Summary

Methods

Modifier and Type	Method and Description
void	addBookmarks(String sid, long[] targetIds, int type) Adds new bookmarks
void	addDocuments(String sid, String encoding, boolean importZip, GUIDocument metadata) Adds new documents previously uploaded, with metadata specification.
void	addDocuments(String sid, String language, long folderId, String encoding, boolean importZip, Long templateId) Adds new documents previously uploaded
long	addNote(String sid, long docId, String message) Adds a new document note on the given document
void	bulkUpdate(String sid, long[] ids, GUIDocument vo) Applies to a selection of documents all the given data.
GUIDocument	checkin(String sid, GUIDocument document, boolean major) Checks-in a new document version
void	checkout(String sid, long docId) Checks out the document
void	cleanUploadedFileFolder(String sid) Cleans the uploaded files folder.
GUIDocument	createEmpty(String sid, GUIDocument vo) Creates a new empty document
void	delete(String sid, long[] ids) Deletes a selection of documents
void	deleteBookmarks(String sid, long[] bookmarkIds) Deletes a set of bookmarks
void	deleteLinks(String sid, long[] ids) Deletes a selection of links
void	deleteNotes(String sid, long[] ids) Deletes a selection of document notes
GUIDocument	deleteVersions(String sid, long[] ids) Deletes a selection of versions
GUIExtendedAttribute[]	getAttributes(String sid, long templateId) Retrieves all attributes of the specified template
GUIDocument	getById(String sid, long docId) Retrieves a specific document by its ID
GUIRating	getRating(String sid, long docId) Retrieves the rating of the given document.
GUIVersion[]	getVersionsById(String sid, long id1, long id2) Retrieves two specific versions by its ID
void	linkDocuments(String sid, long[] inDocIds, long[] outDocIds) Links a set of documents
void	lock(String sid, long[] docIds, String comment) Locks a set of documents
void	makeImmutable(String sid, long[] docIds, String comment) Makes immutable a set of documents
void	markHistoryAsRead(String sid, String event) Marks as read the histories related to the current user and the given event.
void	markIndexable(String sid, long[] docIds) Marks a set of documents as indexable
void	markUnindexable(String sid, long[] docIds) Marks a set of documents as unindexable
void	restore(String sid, long docId, long folderId) Restores a given document
GUIDocument	save(String sid, GUIDocument document) Saves the document in the DB
int	saveRating(String sid, GUIRating rating) Save a rating vote on a document.
String	sendAsEmail(String sid, GUIEmail email) Sends a document as email(attachment or download ticket)
void	unlock(String sid, long[] docIds) Unlocks a set of documents
void	updateBookmark(String sid, GUIBookmark bookmark) Updates a single bookmark's data
void	updateLink(String sid, long id, String type) Updates the links type
void	updateNote(String sid, long docId, long noteId, String message) Updates a document note on the given document

Method Detail

getById

GUIDocument getById(String sid,
                  long docId)
                    throws InvalidSessionException

Retrieves a specific document by its ID

Throws:

InvalidSessionException

save

GUIDocument save(String sid,
               GUIDocument document)
                 throws Exception

Saves the document in the DB

Parameters:

document - The document to save

Returns:

The saved document

Throws:

Exception

getAttributes

GUIExtendedAttribute[] getAttributes(String sid,
                                   long templateId)
                                     throws InvalidSessionException

Retrieves all attributes of the specified template

Throws:

InvalidSessionException

getVersionsById

GUIVersion[] getVersionsById(String sid,
                           long id1,
                           long id2)
                             throws InvalidSessionException

Retrieves two specific versions by its ID

Throws:

InvalidSessionException

sendAsEmail

String sendAsEmail(String sid,
                 GUIEmail email)
                   throws InvalidSessionException

Sends a document as email(attachment or download ticket)

Returns:

"ok" otherwise an error code

Throws:

InvalidSessionException

updateLink

void updateLink(String sid,
              long id,
              String type)
                throws InvalidSessionException

Updates the links type

Parameters:

sid - The session identifier

id - The link identifier

type - The new type to be set

Throws:

InvalidSessionException

deleteLinks

void deleteLinks(String sid,
               long[] ids)
                 throws InvalidSessionException

Deletes a selection of links

Throws:

InvalidSessionException

deleteVersions

GUIDocument deleteVersions(String sid,
                         long[] ids)
                           throws InvalidSessionException

Deletes a selection of versions

Throws:

InvalidSessionException

linkDocuments

void linkDocuments(String sid,
                 long[] inDocIds,
                 long[] outDocIds)
                   throws InvalidSessionException

Links a set of documents

Throws:

InvalidSessionException

delete

void delete(String sid,
          long[] ids)
            throws InvalidSessionException

Deletes a selection of documents

Throws:

InvalidSessionException

makeImmutable

void makeImmutable(String sid,
                 long[] docIds,
                 String comment)
                   throws InvalidSessionException

Makes immutable a set of documents

Throws:

InvalidSessionException

unlock

void unlock(String sid,
          long[] docIds)
            throws InvalidSessionException

Unlocks a set of documents

Throws:

InvalidSessionException

lock

void lock(String sid,
        long[] docIds,
        String comment)
          throws InvalidSessionException

Locks a set of documents

Throws:

InvalidSessionException

checkout

void checkout(String sid,
            long docId)
              throws InvalidSessionException

Checks out the document

Throws:

InvalidSessionException

addDocuments

void addDocuments(String sid,
                String language,
                long folderId,
                String encoding,
                boolean importZip,
                Long templateId)
                  throws InvalidSessionException

Adds new documents previously uploaded

Parameters:

sid - The session identifier

language - The language applied to all documents

folderId - The destination folder identifier

encoding - The zip encoding

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

templateId - The documents template

Throws:

InvalidSessionException

addDocuments

void addDocuments(String sid,
                String encoding,
                boolean importZip,
                GUIDocument metadata)
                  throws InvalidSessionException

Adds new documents previously uploaded, with metadata specification.

Parameters:

sid - The session identifier

vo - The metadata applied to all new documents

encoding - The zip encoding

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

Throws:

InvalidSessionException

checkin

GUIDocument checkin(String sid,
                  GUIDocument document,
                  boolean major)
                    throws Exception

Checks-in a new document version

Parameters:

sid - The session identifier

document - The document to update

major - True if this is a major version

Throws:

Exception

restore

void restore(String sid,
           long docId,
           long folderId)
             throws InvalidSessionException

Restores a given document

Throws:

InvalidSessionException

addBookmarks

void addBookmarks(String sid,
                long[] targetIds,
                int type)
                  throws InvalidSessionException

Adds new bookmarks

Throws:

InvalidSessionException

deleteBookmarks

void deleteBookmarks(String sid,
                   long[] bookmarkIds)
                     throws InvalidSessionException

Deletes a set of bookmarks

Throws:

InvalidSessionException

updateBookmark

void updateBookmark(String sid,
                  GUIBookmark bookmark)
                    throws InvalidSessionException

Updates a single bookmark's data

Throws:

InvalidSessionException

markHistoryAsRead

void markHistoryAsRead(String sid,
                     String event)
                       throws InvalidSessionException

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

Parameters:

sid - The session identifier

event - The history event to mark as read

Throws:

InvalidSessionException

markUnindexable

void markUnindexable(String sid,
                   long[] docIds)
                     throws InvalidSessionException

Marks a set of documents as unindexable

Throws:

InvalidSessionException

markIndexable

void markIndexable(String sid,
                 long[] docIds)
                   throws InvalidSessionException

Marks a set of documents as indexable

Throws:

InvalidSessionException

cleanUploadedFileFolder

void cleanUploadedFileFolder(String sid)
                             throws InvalidSessionException

Cleans the uploaded files folder.

Throws:

InvalidSessionException

getRating

GUIRating getRating(String sid,
                  long docId)
                    throws InvalidSessionException

Retrieves the rating of the given document.

Throws:

InvalidSessionException

saveRating

int saveRating(String sid,
             GUIRating rating)
               throws InvalidSessionException

Save a rating vote on a document.

Returns:

the new document rating value

Throws:

InvalidSessionException

addNote

long addNote(String sid,
           long docId,
           String message)
             throws InvalidSessionException

Adds a new document note on the given document

Throws:

InvalidSessionException

updateNote

void updateNote(String sid,
              long docId,
              long noteId,
              String message)
                throws InvalidSessionException

Updates a document note on the given document

Throws:

InvalidSessionException

deleteNotes

void deleteNotes(String sid,
               long[] ids)
                 throws InvalidSessionException

Deletes a selection of document notes

Throws:

InvalidSessionException

bulkUpdate

void bulkUpdate(String sid,
              long[] ids,
              GUIDocument vo)
                throws InvalidSessionException

Applies to a selection of documents all the given data.

Throws:

InvalidSessionException

createEmpty

GUIDocument createEmpty(String sid,
                      GUIDocument vo)
                        throws InvalidSessionException

Creates a new empty document

Throws:

InvalidSessionException