com.logicaldoc.webservice.document

Interface DocumentService

All Known Implementing Classes:

DocumentClient, DocumentServiceImpl

public interface DocumentService

Document Web Service definition interface

Since:

5.2

Author:

Matteo Caruso - Logical Objects

Method Summary

Methods

Modifier and Type	Method and Description
void	checkin(String sid, long docId, String comment, String filename, boolean release, DataHandler content) Checks in an existing document with the given identifier to create a new version.
void	checkout(String sid, long docId) Checkouts an existing document with the given identifier.
WSDocument	create(String sid, WSDocument document, DataHandler content) Create a new document.
WSDocument	createAlias(String sid, long docId, long folderId) Create a new document alias for the given document id and inside the given folder id.
void	delete(String sid, long docId) Deletes an existing document with the given identifier.
WSDocument[]	getAliases(String sid, long docId) Gets the aliases of the given document
DataHandler	getContent(String sid, long docId) Gets the document content of an existing document with the given identifier.
WSDocument	getDocument(String sid, long docId) Gets document 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.
WSDocument[]	getDocuments(String sid, Long[] docIds) Gets document metadata of a collection of existing documents with the given identifiers.
WSDocument[]	getRecentDocuments(String sid, Integer maxHits) Lists of last modified documents of the current session's user.
DataHandler	getVersionContent(String sid, long docId, String version) Gets the document content of an existing document with the given identifier.
WSDocument[]	getVersions(String sid, long docId) Gets the version history of an existing document with the given identifier.
boolean	isReadable(String sid, long docId) Test if a document identifier is valid.
WSDocument[]	list(String sid, long folderId) Deprecated.
WSDocument[]	listDocuments(String sid, long folderId, String fileName) Gets a document 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	reindex(String sid, long docId) Reindexes(or indexes) a document
void	rename(String sid, long docId, String name) Renames the title of an existing document with the given identifier.
void	renameFile(String sid, long docId, String name) Renames the filename of an existing document with the given identifier.
void	restore(String sid, long docId, long folderId) Restores an existing document with the given identifier.
void	sendEmail(String sid, Long[] docIds, String recipients, String subject, String message) Sends a set of documents as mail attachments
void	unlock(String sid, long docId) Unlocks an existing document with the given identifier.
void	update(String sid, WSDocument document) Updates an existing document with the value object containing the document's metadata.

Method Detail

create

WSDocument create(String sid,
                WSDocument document,
                DataHandler content)
                  throws Exception

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

Parameters:

sid - Session identifier

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:

Exception

delete

void delete(String sid,
          long docId)
            throws Exception

Deletes an existing document with the given identifier.

Parameters:

sid - Session identifier

docId - The document id

Throws:

Exception

lock

void lock(String sid,
        long docId)
          throws Exception

Locks an existing document with the given identifier.

Parameters:

sid - Session identifier

docId - The document id

Throws:

Exception

unlock

void unlock(String sid,
          long docId)
            throws Exception

Unlocks an existing document with the given identifier.

Parameters:

sid - Session identifier

docId - The document id

Throws:

Exception

rename

void rename(String sid,
          long docId,
          String name)
            throws Exception

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

Parameters:

sid - Session identifier

docId - The document id

name - The new document title

Throws:

Exception

renameFile

void renameFile(String sid,
              long docId,
              String name)
                throws Exception

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

Parameters:

sid - Session identifier

docId - The document id

name - The new document file name

Throws:

Exception

move

void move(String sid,
        long docId,
        long folderId)
          throws Exception

Moves an existing document with the given identifier.

Parameters:

sid - Session identifier

docId - The document id

folderId - The folder id of the new document folder

Throws:

Exception

getDocument

WSDocument getDocument(String sid,
                     long docId)
                       throws Exception

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

Parameters:

sid - Session identifier

docId - The document id

Returns:

A value object containing the document's metadata.

Throws:

Exception

getDocumentByCustomId

WSDocument getDocumentByCustomId(String sid,
                               String customId)
                                 throws Exception

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

Parameters:

sid - Session identifier

customId - The custom id

Returns:

A value object containing the document's metadata.

Throws:

Exception

getDocuments

WSDocument[] getDocuments(String sid,
                        Long[] docIds)
                          throws Exception

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

Parameters:

sid - Session identifier

docIds - The documents ids

Returns:

A value object containing the document's metadata.

Throws:

Exception

getAliases

WSDocument[] getAliases(String sid,
                      long docId)
                        throws Exception

Gets the aliases of the given document

Parameters:

sid - Session identifier

docId - The master document ID

Returns:

Arrays of aliases

Throws:

Exception

update

void update(String sid,
          WSDocument document)
            throws Exception

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

Parameters:

sid - Session identifier

doc - The value object containing the document's metadata.

Throws:

Exception

getContent

DataHandler getContent(String sid,
                     long docId)
                       throws Exception

Gets the document content of an existing document with the given identifier.

Parameters:

sid - Session identifier

docId - The document id

Returns:

The requested document's binary

Throws:

Exception

getVersionContent

DataHandler getVersionContent(String sid,
                            long docId,
                            String version)
                              throws Exception

Gets the document content of an existing document with the given identifier.

Parameters:

sid - Session identifier

docId - The document id

version - The specific version(it can be empty)

Returns:

The requested document's binary

Throws:

Exception

checkout

void checkout(String sid,
            long docId)
              throws Exception

Checkouts an existing document with the given identifier.

Parameters:

sid - Session identifier

docId - The document id

Throws:

Exception

checkin

void checkin(String sid,
           long docId,
           String comment,
           String filename,
           boolean release,
           DataHandler content)
             throws Exception

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

Parameters:

sid - Session identifier

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:

Exception

isReadable

boolean isReadable(String sid,
                 long docId)
                   throws Exception

Test if a document identifier is valid.

Parameters:

sid - Session identifier

docId - The document id

Returns:

True if the identifier denotes a document, otherwise false.

Throws:

Exception

restore

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

Restores an existing document with the given identifier.

Parameters:

sid - Session identifier

docId - The document id

folderId - The target folder id

Throws:

Exception

getVersions

WSDocument[] getVersions(String sid,
                       long docId)
                         throws Exception

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

Parameters:

sid - Session identifier

docId - The document id

Returns:

Array of versions

Throws:

Exception

list

@Deprecated
WSDocument[] list(String sid,
                           long folderId)
                  throws Exception

Deprecated.

Lists the documents inside a folder

Parameters:

sid - Session identifier

folderId - The document id

Returns:

Array of documents contained in the folder

Throws:

Exception

listDocuments

WSDocument[] listDocuments(String sid,
                         long folderId,
                         String fileName)
                           throws Exception

Gets a document in a specific folder

Parameters:

sid - Session identifier

folderId - The folder id

fileName - Optional file name filter

Returns:

A value object containing the document's metadata.

Throws:

Exception

getRecentDocuments

WSDocument[] getRecentDocuments(String sid,
                              Integer maxHits)
                                throws Exception

Lists of last modified documents of the current session's user.

Parameters:

sid - Session identifier

maxHits - Maximum number of returned records

Returns:

Array of documents

Throws:

Exception

sendEmail

void sendEmail(String sid,
             Long[] docIds,
             String recipients,
             String subject,
             String message)
               throws Exception

Sends a set of documents as mail attachments

Parameters:

sid - Session identifiers

docIds - Set of document ids

recipients - Set of recipients(comma separated)

subject - The email subject

message - The email message body

Throws:

Exception

createAlias

WSDocument createAlias(String sid,
                     long docId,
                     long folderId)
                       throws Exception

Create a new document alias for the given document id and inside the given folder id.

Parameters:

sid - Session identifier

docId - The original document id

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

Returns:

The value object containing the document's metadata.

Throws:

Exception

reindex

void reindex(String sid,
           long docId)
             throws Exception

Reindexes(or indexes) a document

Parameters:

sid - Session identifier

docId - The document id

Throws:

Exception