com.logicaldoc.gui.frontend.client.services

Interface GDocsService

All Superinterfaces:

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

@RemoteServiceRelativePath(value="gdocs")
public interface GDocsService
extends com.google.gwt.user.client.rpc.RemoteService

The client side stub for the Google Docs Service.

Since:

6.7

Author:

Marco Meschieri - Logical Objects

Method Summary

Methods

Modifier and Type	Method and Description
GUIDocument	checkin(String sid, long docId, String comment, boolean major) Performs the check-in of a Google Docs's document into the LogicalDOC repository.
String	create(String sid, String title, String type) Performs the creation of a new Google Docs's document.
void	delete(String sid, String resourceId) Deletes a document to Google Docs.
String[]	exportDocuments(String sid, long[] ids) Exports a selection of documents from LogicalDOC into GoogleDocs
void	importDocuments(String sid, String[] resourceIds, long targetFolderId, String format) Imports some Google documents into LogicalDOC
String[]	loadSettings(String sid) Retrieve the settings saved for connecting to Google Docs.
void	saveSettings(String sid, String username, String password) Save the settings used by the Google Docs module
GUIDocument[]	search(String sid, String expression) Search in documents into Google Docs
String	upload(String sid, long docId) Uploads a document to Google Docs.

Method Detail

upload

String upload(String sid,
            long docId)
              throws InvalidSessionException

Uploads a document to Google Docs.

Parameters:

docId - ID of the document to upload

Throws:

InvalidSessionException

delete

void delete(String sid,
          String resourceId)
            throws InvalidSessionException

Deletes a document to Google Docs.

Parameters:

docId - ID of the document to delete

Throws:

InvalidSessionException

checkin

GUIDocument checkin(String sid,
                  long docId,
                  String comment,
                  boolean major)
                    throws InvalidSessionException

Performs the check-in of a Google Docs's document into the LogicalDOC repository.

Parameters:

sid - The session identifier

docId - ID of the document to update

comment - The comment left for the checkin

major - If this is a major or minor release

Returns:

The checked-in document

Throws:

InvalidSessionException

create

String create(String sid,
            String title,
            String type)
              throws InvalidSessionException

Performs the creation of a new Google Docs's document.

Parameters:

sid - The session identifier

title - Title of the new document

type - The type of the new document ('doc', 'xls' ...)

Throws:

InvalidSessionException

importDocuments

void importDocuments(String sid,
                   String[] resourceIds,
                   long targetFolderId,
                   String format)
                     throws InvalidSessionException

Imports some Google documents into LogicalDOC

Parameters:

sid - The session identifier

resourceIds - IDS of the documents to import

targetFolderId - ID of the import folder

format - The type of the documents

Throws:

InvalidSessionException

exportDocuments

String[] exportDocuments(String sid,
                       long[] ids)
                         throws InvalidSessionException

Exports a selection of documents from LogicalDOC into GoogleDocs

Parameters:

sid - The session identifier

ids - The ids of the document to be exported

Returns:

The list of the imported documents into Google Docs

Throws:

InvalidSessionException

saveSettings

void saveSettings(String sid,
                String username,
                String password)
                  throws InvalidSessionException

Save the settings used by the Google Docs module

Parameters:

sid -

username -

password -

Throws:

InvalidSessionException

loadSettings

String[] loadSettings(String sid)
                      throws InvalidSessionException

Retrieve the settings saved for connecting to Google Docs.

Throws:

InvalidSessionException

search

GUIDocument[] search(String sid,
                   String expression)
                     throws InvalidSessionException

Search in documents into Google Docs

Parameters:

sid -

expression -

Throws:

InvalidSessionException