Package com.logicaldoc.webservice.soap

Interface DocumentService

All Known Implementing Classes:

RestDocumentService, RestDocumentSwagger, SoapDocumentClient, SoapDocumentService

public interface DocumentService

Document Web Service definition interface

Since:

5.2

Author:

Matteo Caruso - LogicalDOC

Method Summary

Modifier and Type	Method	Description
WSNote	addNote(String sid, long docId, String note)	Adds a new note for the given document
void	checkin(String sid, long docId, String comment, String filename, boolean release, javax.activation.DataHandler content)	Checks in an existing document with the given identifier to create a new version.
void	checkinDocument(String sid, long docId, String comment, String filename, boolean release, WSDocument docVO, javax.activation.DataHandler content)	Checks in an existing document with the given identifier to create a new version.
void	checkout(String sid, long docId)	Checks out an existing document with the given identifier.
WSDocument	copy(String sid, long docId, long folderId, boolean links, boolean notes, boolean security)	Copies a document into another folder.
WSDocument	create(String sid, WSDocument document, javax.activation.DataHandler content)	Create a new document.
WSDocument	createAlias(String sid, long docId, long folderId, String type)	Creates a new document alias for the given document inside a specified folder
String	createDownloadTicket(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads)	Creates a new download ticket
void	createPdf(String sid, long docId, String fileVersion)	Creates the PDF conversion of the given document.
void	createThumbnail(String sid, long docId, String fileVersion, String type)	Creates the thumbnail of the given document.
String	createViewTicket(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads, Integer maxViews)	Creates a new view ticket
void	delete(String sid, long docId)	Deletes an existing document with the given identifier.
void	deleteLink(String sid, long id)	Removes an existing link
void	deleteNote(String sid, long noteId)	Adds a new note for the given document
String	deleteVersion(String sid, long docId, String version)	Deletes a version of a document with the given identifiers.
List<WSAccessControlEntry>	getAccessControlList(String sid, long docId)	Retrieves the access control list
List<WSDocument>	getAliases(String sid, long docId)	Gets the aliases of the given document
javax.activation.DataHandler	getContent(String sid, long docId)	Gets the content of an existing document with the given identifier
WSDocument	getDocument(String sid, long docId)	Gets the metadata of an existing document with the given identifier
WSDocument	getDocumentByCustomId(String sid, String customId)	Gets document metadata of an existing document with the given custom identifier
List<WSDocument>	getDocuments(String sid, List<Long> docIds)	Gets document metadata of a collection of existing documents with the given identifiers
String	getExtractedText(String sid, long docId)	Gets the document's text stored in the full-text index
List<WSLink>	getLinks(String sid, long docId)	Gets all the links of a specific document
List<WSNote>	getNotes(String sid, long docId)	Gets the notes for the given document
List<WSRating>	getRatings(String sid, long docId)	Gets all the ratings of the given document
List<WSDocument>	getRecentDocuments(String sid, Integer maxHits)	Lists of last modified documents of the current session.
javax.activation.DataHandler	getResource(String sid, long docId, String fileVersion, String suffix)	Gets the content of a resource associated to the given document.
WSDocument	getVersion(String sid, long docId, String version)	Gets a specific version
javax.activation.DataHandler	getVersionContent(String sid, long docId, String version)	Gets the content of a specific version of a document
List<WSDocument>	getVersions(String sid, long docId)	Gets the version history of an existing document with the given identifier
boolean	isDownload(String sid, long docId)	Tests if a document is downloadable
boolean	isGranted(String sid, long docId, String permission)	Tests if the current user has a specific permission on a document
boolean	isRead(String sid, long docId)	Tests if a document is readable.
boolean	isWrite(String sid, long docId)	Tests if a document is writable
WSLink	link(String sid, long doc1, long doc2, String type)	Creates a new link between two documents.
List<WSDocument>	list(String sid, long folderId, String fileName, String sort, Integer page, Integer max)	Gets the documents in a specific folder
List<WSDocument>	listDocuments(String sid, long folderId, String fileName)	Gets the documents in a specific folder
void	lock(String sid, long docId)	Locks an existing document with the given identifier.
void	move(String sid, long docId, long folderId)	Moves an existing document with the given identifier.
void	promoteVersion(String sid, long docId, String version)	Promotes an old version to the current default one.
WSRating	rateDocument(String sid, long docId, int vote)	Puts a new rating on the given document
void	reindex(String sid, long docId, String content)	Re-indexes(or indexes from scratch) a document
void	rename(String sid, long docId, String name)	Renames the title of an existing document with the given identifier.
void	replaceFile(String sid, long docId, String fileVersion, String comment, javax.activation.DataHandler content)	Replaces the file associated to a given version.
void	restore(String sid, long docId, long folderId)	Restores a deleted document
WSNote	saveNote(String sid, long docId, WSNote note)	Adds a new note for the given document
void	sendEmail(String sid, List<Long> docIds, String recipients, String subject, String message)	Sends a set of documents as mail attachments
void	setAccessControlList(String sid, long docId, List<WSAccessControlEntry> acl)	Sets the Access Control List
void	setPassword(String sid, long docId, String password)	Puts a password protection to the document
void	unlock(String sid, long docId)	Unlocks an existing document with the given identifier.
boolean	unprotect(String sid, long docId, String password)	Unprotects a document that is password protected.
void	unsetPassword(String sid, long docId, String currentPassword)	Removes the password protection from the document
void	update(String sid, WSDocument document)	Updates an existing document with the value object containing the document's metadata
long	upload(String sid, Long docId, Long folderId, boolean release, String filename, String language, javax.activation.DataHandler content)	Creates a new document or updates an existing one.
void	uploadResource(String sid, long docId, String fileVersion, String suffix, javax.activation.DataHandler content)	Uploads a new resource attached to the given document.

Method Details

create

WSDocument create(String sid,
 WSDocument document,
 javax.activation.DataHandler content)
           throws IOException,
AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Create a new document. The user can completely customize the document through a value object containing the document's metadata

Parameters:

sid - identifier of the session

document - Web service value object containing the document's metadata

content - The document's binary content

Returns:

The value object containing the document's metadata

Throws:

IOException - I/O error

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

delete

void delete(String sid,
 long docId)
     throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException

Deletes an existing document with the given identifier.

Parameters:

sid - identifier of the session

docId - The document id

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

lock

void lock(String sid,
 long docId)
   throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
UnexistingResourceException

Locks an existing document with the given identifier.

Parameters:

sid - identifier of the session

docId - The document id

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

UnexistingResourceException - The requested document does not exist

unlock

void unlock(String sid,
 long docId)
     throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
UnexistingResourceException

Unlocks an existing document with the given identifier.

Parameters:

sid - identifier of the session

docId - identifier of the document

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

UnexistingResourceException - The specified document does not exist

rename

void rename(String sid,
 long docId,
 String name)
     throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
UnexistingResourceException

Renames the title of an existing document with the given identifier.

Parameters:

sid - identifier of the session

docId - The document id

name - The new document title

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

UnexistingResourceException - The specified document does not exist

move

void move(String sid,
 long docId,
 long folderId)
   throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
UnexistingResourceException

Moves an existing document with the given identifier.

Parameters:

sid - identifier of the session

docId - The document id

folderId - Identifier of the new document's folder

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

UnexistingResourceException - The specified document does not exist

copy

WSDocument copy(String sid,
 long docId,
 long folderId,
 boolean links,
 boolean notes,
 boolean security)
         throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
IOException

Copies a document into another folder.

Parameters:

sid - identifier of the session

docId - The document id

folderId - Identifier of the new document's folder

links - If links must be copied too

notes - If notes and annotations must be copied too

Returns:

The created copy

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

IOException - I/O error

getDocument

WSDocument getDocument(String sid,
 long docId)
                throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
UnexistingResourceException

Gets the metadata of an existing document with the given identifier

Parameters:

sid - identifier of the session

docId - The document id

Returns:

A value object containing the document's metadata

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

UnexistingResourceException - the required document does not exist

getDocumentByCustomId

WSDocument getDocumentByCustomId(String sid,
 String customId)
                          throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException

Gets document metadata of an existing document with the given custom identifier

Parameters:

sid - identifier of the session

customId - The custom id

Returns:

A value object containing the document's metadata

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

getDocuments

List<WSDocument> getDocuments(String sid,
 List<Long> docIds)
                       throws AuthenticationException,
WebserviceException,
PersistenceException

Gets document metadata of a collection of existing documents with the given identifiers

Parameters:

sid - identifier of the session

docIds - identifiers of the documents

Returns:

the list of documents

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getAliases

List<WSDocument> getAliases(String sid,
 long docId)
                     throws AuthenticationException,
WebserviceException,
PersistenceException

Gets the aliases of the given document

Parameters:

sid - identifier of the session

docId - The master document ID

Returns:

List of aliases

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

update

void update(String sid,
 WSDocument document)
     throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException,
UnexistingResourceException

Updates an existing document with the value object containing the document's metadata

Parameters:

sid - identifier of the session

document - The value object containing the document's metadata

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

UnexistingResourceException - The specified document does not exist

getContent

javax.activation.DataHandler getContent(String sid,
 long docId)
                                 throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
IOException

Gets the content of an existing document with the given identifier

Parameters:

sid - identifier of the session

docId - The document id

Returns:

The requested document's binary

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

IOException - I/O error

getExtractedText

String getExtractedText(String sid,
 long docId)
                 throws AuthenticationException,
WebserviceException,
PersistenceException

Gets the document's text stored in the full-text index

Parameters:

sid - identifier of the session

docId - The document id

Returns:

The requested document's text

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getVersionContent

javax.activation.DataHandler getVersionContent(String sid,
 long docId,
 String version)
                                        throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
IOException

Gets the content of a specific version of a document

Parameters:

sid - identifier of the session

docId - The document id

version - The specific version(it can be empty)

Returns:

The requested version's binary

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

IOException - I/O error

getResource

javax.activation.DataHandler getResource(String sid,
 long docId,
 String fileVersion,
 String suffix)
                                  throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
IOException

Gets the content of a resource associated to the given document.

Parameters:

sid - identifier of the session

docId - The document id

fileVersion - The specific file version(it can be empty)

suffix - Suffix specification(it can be empty, conversion.pdf to get the PDF conversion)

Returns:

The requested resource's binary

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

IOException - I/O error

checkout

void checkout(String sid,
 long docId)
       throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException

Checks out an existing document with the given identifier.

Parameters:

sid - identifier of the session

docId - The document id

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

checkin

void checkin(String sid,
 long docId,
 String comment,
 String filename,
 boolean release,
 javax.activation.DataHandler content)
      throws IOException,
AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Checks in an existing document with the given identifier to create a new version.

Parameters:

sid - identifier of the session

docId - The document id

comment - The check in operation comment

filename - The document file name

release - True if this is a new release(eg: 2.0) rather than a subversion(eg: 1.1)

content - The document's binary content

Throws:

IOException - I/O error

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

checkinDocument

void checkinDocument(String sid,
 long docId,
 String comment,
 String filename,
 boolean release,
 WSDocument docVO,
 javax.activation.DataHandler content)
              throws IOException,
AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Checks in an existing document with the given identifier to create a new version.

Parameters:

sid - identifier of the session

docId - The document id

comment - The check in operation comment

filename - The document file name

release - True if this is a new release(e.g.: 2.0) rather than a subversion(e.g.: 1.1)

docVO - metadata for the document

content - The document's binary content

Throws:

IOException - I/O error

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

replaceFile

void replaceFile(String sid,
 long docId,
 String fileVersion,
 String comment,
 javax.activation.DataHandler content)
          throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
IOException,
UnexistingResourceException

Replaces the file associated to a given version.

Parameters:

sid - identifier of the session

docId - The document id

fileVersion - The file version

comment - The comment left for this action

content - The file's binary content

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

IOException - I/O error

UnexistingResourceException - The specified document does not exist

promoteVersion

void promoteVersion(String sid,
 long docId,
 String version)
             throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
IOException,
UnexistingResourceException

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

Parameters:

sid - identifier of the session

docId - the document to be updated

version - the version

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

IOException - I/O error

UnexistingResourceException - The specified document does not exist

upload

long upload(String sid,
 Long docId,
 Long folderId,
 boolean release,
 String filename,
 String language,
 javax.activation.DataHandler content)
     throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
IOException

Creates a new document or updates an existing one.

Parameters:

sid - identifier of the session

docId - The document id (optional)

folderId - The folder id (optional)

release - True if this is a major release(eg: 2.0) rather than a minor release(eg: 1.12)

filename - The document file name

language - The language for the document

content - The document's binary content

Returns:

The created/updated document's ID

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

IOException - I/O erro

uploadResource

void uploadResource(String sid,
 long docId,
 String fileVersion,
 String suffix,
 javax.activation.DataHandler content)
             throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
IOException

Uploads a new resource attached to the given document. If the resource already exists it is overwritten.

Parameters:

sid - Session identifier

docId - The document id

fileVersion - The specific file version(it can be empty)

suffix - Suffix specification(it cannot be empty, use 'conversion.pdf' to put the PDF conversion)

content - The resource's binary content

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

IOException - I/O error

restore

void restore(String sid,
 long docId,
 long folderId)
      throws AuthenticationException,
WebserviceException,
PersistenceException

Restores a deleted document

Parameters:

sid - identifier of the session

docId - The document id

folderId - Id of the folder in which the document must be restored

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getVersions

List<WSDocument> getVersions(String sid,
 long docId)
                      throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
UnexistingResourceException

Gets the version history of an existing document with the given identifier

Parameters:

sid - identifier of the session

docId - The document id

Returns:

Collection of versions

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

UnexistingResourceException - The specified document does not exist

getVersion

WSDocument getVersion(String sid,
 long docId,
 String version)
               throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
UnexistingResourceException

Gets a specific version

Parameters:

sid - identifier of the session

docId - The document id

version - The version number

Returns:

The version

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

UnexistingResourceException - The specified document does not exist

listDocuments

List<WSDocument> listDocuments(String sid,
 long folderId,
 String fileName)
                        throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException

Gets the documents in a specific folder

Parameters:

sid - identifier of the session

folderId - The folder id

fileName - Optional file name filter

Returns:

Collection of documents

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

list

List<WSDocument> list(String sid,
 long folderId,
 String fileName,
 String sort,
 Integer page,
 Integer max)
               throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException

Gets the documents in a specific folder

Parameters:

sid - identifier of the session

folderId - The folder id

fileName - Optional file name filter

sort - Optional sort criteria (eg date asc)

page - Optional page number

max - Optional maximum number of elements per page

Returns:

Collection of documents

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

getRecentDocuments

List<WSDocument> getRecentDocuments(String sid,
 Integer maxHits)
                             throws AuthenticationException,
WebserviceException,
PersistenceException

Lists of last modified documents of the current session.

Parameters:

sid - identifier of the session

maxHits - Maximum number of returned records

Returns:

List of documents

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

sendEmail

void sendEmail(String sid,
 List<Long> docIds,
 String recipients,
 String subject,
 String message)
        throws AuthenticationException,
WebserviceException,
PersistenceException,
IOException,
javax.mail.MessagingException

Sends a set of documents as mail attachments

Parameters:

sid - identifier of the session

docIds - Set of document identifiers

recipients - Set of recipients(comma separated)

subject - The email subject

message - The email message body

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

IOException - I/O error

javax.mail.MessagingException - error sending the email

createAlias

WSDocument createAlias(String sid,
 long docId,
 long folderId,
 String type)
                throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException

Creates a new document alias for the given document inside a specified folder

Parameters:

sid - identifier of the session

docId - The original document id

folderId - Identifier of the folder in which will be stored the alias.

type - Type of the alias

Returns:

The value object containing the document's metadata

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

link

WSLink link(String sid,
 long doc1,
 long doc2,
 String type)
     throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
UnexistingResourceException

Creates a new link between two documents.

Parameters:

sid - identifier of the session

doc1 - ID of document 1

doc2 - ID of document 2

type - The link type(it can be empty)

Returns:

the new link

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

UnexistingResourceException - The specified document does not exist

getLinks

List<WSLink> getLinks(String sid,
 long docId)
               throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException

Gets all the links of a specific document

Parameters:

sid - Session identifier

docId - ID of the document

Returns:

The new links of the document

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

deleteLink

void deleteLink(String sid,
 long id)
         throws AuthenticationException,
WebserviceException,
PersistenceException

Removes an existing link

Parameters:

sid - identifier of the session

id - ID of the link

Throws:

PersistenceException - Error at data layer

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

reindex

void reindex(String sid,
 long docId,
 String content)
      throws AuthenticationException,
WebserviceException,
PersistenceException,
ParsingException

Re-indexes(or indexes from scratch) a document

Parameters:

sid - Session identifier

docId - The document id

content - The content to be used (if null the file is parsed)

Throws:

PersistenceException - Error at data layer

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

ParsingException - Error in adding the entry into fulltext index

createPdf

void createPdf(String sid,
 long docId,
 String fileVersion)
        throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
IOException

Creates the PDF conversion of the given document. If the conversion was already created, nothing will happen.

Parameters:

sid - identifier of the session

docId - The document id

fileVersion - The specific file version(it can be empty)

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

IOException - I/O error

createThumbnail

void createThumbnail(String sid,
 long docId,
 String fileVersion,
 String type)
              throws AuthenticationException,
WebserviceException,
PersistenceException,
IOException

Creates the thumbnail of the given document. If the thumbnail was already created, nothing will happen.

Parameters:

sid - Session identifier

docId - The document id

fileVersion - The specific file version(it can be empty)

type - The thumbnail type(eg: thumb, tile, mobile, thumbXXX where XXX is a resolution in pixels)

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

IOException - I/O error

createDownloadTicket

String createDownloadTicket(String sid,
 long docId,
 String suffix,
 Integer expireHours,
 String expireDate,
 Integer maxDownloads)
                     throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException

Creates a new download ticket

Parameters:

sid - identifier of the session

docId - identifier of the document

suffix - can be null or 'conversion.pdf'

expireHours - expiration time expressed in hours

expireDate - exact expiration date expressed in the format yyyy-MM-dd

maxDownloads - maximum number of downloads allowed

Returns:

the download ticket

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the download permission

createViewTicket

String createViewTicket(String sid,
 long docId,
 String suffix,
 Integer expireHours,
 String expireDate,
 Integer maxDownloads,
 Integer maxViews)
                 throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException

Creates a new view ticket

Parameters:

sid - identifier of the session

docId - identifier of the document

suffix - can be null or 'conversion.pdf'

expireHours - expiration time expressed in hours

expireDate - exact expiration date expressed in the format yyyy-MM-dd

maxDownloads - maximum number of downloads allowed

maxViews - maximum number of downloads allowed

Returns:

the download ticket

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the download permission

setPassword

void setPassword(String sid,
 long docId,
 String password)
          throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
UnexistingResourceException

Puts a password protection to the document

Parameters:

sid - identifier of the session

docId - identifier of the document

password - the new password

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

UnexistingResourceException - The specified document does not exist

unsetPassword

void unsetPassword(String sid,
 long docId,
 String currentPassword)
            throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
UnexistingResourceException

Removes the password protection from the document

Parameters:

sid - identifier of the session

docId - identifier of the document

currentPassword - the password

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

UnexistingResourceException - The specified document does not exist

unprotect

boolean unprotect(String sid,
 long docId,
 String password)
           throws PersistenceException,
AuthenticationException,
WebserviceException

Unprotects a document that is password protected. If the given password is right, the document remains unprotected for the duration of the session

Parameters:

sid - identifier of the session

docId - identifier of the document

password - the password

Returns:

was it uprotected?

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

addNote

WSNote addNote(String sid,
 long docId,
 String note)
        throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
UnexistingResourceException

Adds a new note for the given document

Parameters:

sid - identifier of the session

docId - identifier of the document

note - text of the note

Returns:

the created note

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

UnexistingResourceException - The specified document does not exist

saveNote

WSNote saveNote(String sid,
 long docId,
 WSNote note)
         throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
UnexistingResourceException

Adds a new note for the given document

Parameters:

sid - identifier of the session

docId - identifier of the document

note - the note to add

Returns:

the added note

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

UnexistingResourceException - The specified document does not exist

deleteNote

void deleteNote(String sid,
 long noteId)
         throws AuthenticationException,
WebserviceException,
PersistenceException

Adds a new note for the given document

Parameters:

sid - identifier of the session

noteId - identifier of the note

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getNotes

List<WSNote> getNotes(String sid,
 long docId)
               throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
UnexistingResourceException

Gets the notes for the given document

Parameters:

sid - identifier of the session

docId - identifier of the document

Returns:

list of notes

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

UnexistingResourceException - The specified document does not exist

deleteVersion

String deleteVersion(String sid,
 long docId,
 String version)
              throws AuthenticationException,
WebserviceException,
PersistenceException

Deletes a version of a document with the given identifiers. You can not delete the latest version of a document

Parameters:

sid - identifier of the session

docId - The document id

version - The specific version

Returns:

the latest version specification

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

rateDocument

WSRating rateDocument(String sid,
 long docId,
 int vote)
               throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
UnexistingResourceException

Puts a new rating on the given document

Parameters:

sid - identifier of the session

docId - identifier of the document

vote - the vote

Returns:

the rating

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

UnexistingResourceException - The specified document does not exist

getRatings

List<WSRating> getRatings(String sid,
 long docId)
                   throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException,
UnexistingResourceException

Gets all the ratings of the given document

Parameters:

sid - identifier of the session

docId - identifier of the document

Returns:

List of ratings

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

UnexistingResourceException - The specified document does not exist

setAccessControlList

void setAccessControlList(String sid,
 long docId,
 List<WSAccessControlEntry> acl)
                   throws PersistenceException,
PermissionException,
AuthenticationException,
WebserviceException

Sets the Access Control List

Parameters:

sid - Session identifier

docId - Document id

acl - the complete Access Control List

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

getAccessControlList

List<WSAccessControlEntry> getAccessControlList(String sid,
 long docId)
                                         throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException

Retrieves the access control list

Parameters:

sid - Session identifier

docId - Document id

Returns:

'error' if error occurred, the right objects collection

Throws:

PermissionException - The permission has not been granted

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

isRead

boolean isRead(String sid,
 long docId)
        throws AuthenticationException,
WebserviceException,
PersistenceException

Tests if a document is readable.

Parameters:

sid - Session identifier

docId - The document id

Returns:

True if the identifier denotes a readable document, otherwise false.

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

isWrite

boolean isWrite(String sid,
 long docId)
         throws AuthenticationException,
WebserviceException,
PersistenceException

Tests if a document is writable

Parameters:

sid - Session identifier

docId - The document id

Returns:

True if the identifier denotes a writable folder, otherwise false

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

isDownload

boolean isDownload(String sid,
 long docId)
            throws AuthenticationException,
WebserviceException,
PersistenceException

Tests if a document is downloadable

Parameters:

sid - Session identifier

docId - The document id

Returns:

True if the identifier denotes a writable folder, otherwise false

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

isGranted

boolean isGranted(String sid,
 long docId,
 String permission)
           throws AuthenticationException,
WebserviceException,
PersistenceException

Tests if the current user has a specific permission on a document

Parameters:

sid - Session identifier

docId - The document id

permission - The permission to check (eg: 'read', 'write', ...)

Returns:

True if the identifier denotes a granted permission, otherwise false

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session