com.tibco.bpm.web.client.services.client.cmis
Class ClientServices

java.lang.Object
  com.tibco.bpm.web.client.services.client.data.AbstractDataClientService
      com.tibco.bpm.web.client.services.client.cmis.ClientServices

public class ClientServices
extends AbstractDataClientService

Field Summary

Fields inherited from class com.tibco.bpm.web.client.services.client.data.AbstractDataClientService

BASE_URL, XMLFRAGMENT

Method Summary

void	createDocumentWithURL(java.lang.String caseRef, java.lang.String url, java.lang.String fileName, java.lang.String docName, java.lang.String mimeType, java.lang.String versionState, com.google.gwt.user.client.rpc.AsyncCallback<CreateDocumentResponse> callback) Creates a new document in the CMIS repository based on the file URL.
void	deleteDocument(java.lang.String docReference, com.google.gwt.user.client.rpc.AsyncCallback<DeleteDocumentResponse> callback) Deletes the given document from CMIS.
void	deleteOrphanFolders(boolean returnFailures, java.lang.String date, com.google.gwt.user.client.rpc.AsyncCallback<DeleteOrphanFoldersResponse> callback) Deletes the orphan case folders from the repository.
void	getDocumentAttributes(java.lang.String docReference, com.google.gwt.user.client.rpc.AsyncCallback<GetDocumentAttributesResponse> callback) Gets the document attributes for given document in the CMIS.
static ClientServices	getInstance()
void	linkDocument(java.lang.String docReference, java.lang.String caseReference, com.google.gwt.user.client.rpc.AsyncCallback<LinkDocumentResponse> callback) Links an existing document from CMIS to the case instance.
void	listFolderContents(java.lang.String caseReference, boolean metadata, int depth, com.google.gwt.user.client.rpc.AsyncCallback<ListFolderContentsResponse> callback) Retrieves the folder contents for a given case reference.
void	moveDocument(java.lang.String docReference, java.lang.String sourceCaseReference, java.lang.String targetCaseReference, com.google.gwt.user.client.rpc.AsyncCallback<MoveDocumentResponse> callback) Moves an existing document associated with one case instance to another case instance.
void	unlinkDocument(java.lang.String docReference, java.lang.String caseReference, com.google.gwt.user.client.rpc.AsyncCallback<UnlinkDocumentResponse> callback) UnLinks an existing document from a give case instance.

Methods inherited from class com.tibco.bpm.web.client.services.client.data.AbstractDataClientService

cleanseResponse, getHeaders, getServiceURL

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static ClientServices getInstance()

createDocumentWithURL

public void createDocumentWithURL(java.lang.String caseRef,
                                  java.lang.String url,
                                  java.lang.String fileName,
                                  java.lang.String docName,
                                  java.lang.String mimeType,
                                  java.lang.String versionState,
                                  com.google.gwt.user.client.rpc.AsyncCallback<CreateDocumentResponse> callback)

Creates a new document in the CMIS repository based on the file URL.

Parameters:

caseRef - Case reference

url - HTTP URL for the file to be stored

fileName -

docName -

mimeType -

versionState -

callback - of CreateDocumentResponse type

Since:

3.1

deleteDocument

public void deleteDocument(java.lang.String docReference,
                           com.google.gwt.user.client.rpc.AsyncCallback<DeleteDocumentResponse> callback)

Deletes the given document from CMIS.

Parameters:

docReference - Reference to the document in CMIS

callback - Callback to process the DocumentDeleteResponse

Since:

3.1.0

deleteOrphanFolders

public void deleteOrphanFolders(boolean returnFailures,
                                java.lang.String date,
                                com.google.gwt.user.client.rpc.AsyncCallback<DeleteOrphanFoldersResponse> callback)

Deletes the orphan case folders from the repository.

Parameters:

date - in format yyyy-dd-mm

returnFailures - Flag for returning the folder paths for the failures

callback - Callback to process the DeleteOrphanFoldersResponse

Since:

3.1.0

getDocumentAttributes

public void getDocumentAttributes(java.lang.String docReference,
                                  com.google.gwt.user.client.rpc.AsyncCallback<GetDocumentAttributesResponse> callback)

Gets the document attributes for given document in the CMIS. The document attributes are wrapped in the GetDocumentAttributesResponse object.

Parameters:

docReference - Reference to the document in CMIS for which document attributes are retrieved.

callback - Callback to process the GetDocumentAttributesResponse

Since:

3.1.0

linkDocument

public void linkDocument(java.lang.String docReference,
                         java.lang.String caseReference,
                         com.google.gwt.user.client.rpc.AsyncCallback<LinkDocumentResponse> callback)

Links an existing document from CMIS to the case instance.

Parameters:

docReference - Reference to the document in CMIS

caseReference - Reference to the case instance

callback - Callback to process the LinkDocumentResponse

Since:

3.1.0

listFolderContents

public void listFolderContents(java.lang.String caseReference,
                               boolean metadata,
                               int depth,
                               com.google.gwt.user.client.rpc.AsyncCallback<ListFolderContentsResponse> callback)

Retrieves the folder contents for a given case reference.

Parameters:

caseReference - Refer

metadata - boolean flag is set to true if document attributes need to be retrieved.

depth - depth of the folder structure. -1 is set for no limit for the hierarchy.

callback - Callback to process the documents/folders for the given case reference. The callback uses ListFolderContentsResponse object to process the result.

Since:

3.10

moveDocument

public void moveDocument(java.lang.String docReference,
                         java.lang.String sourceCaseReference,
                         java.lang.String targetCaseReference,
                         com.google.gwt.user.client.rpc.AsyncCallback<MoveDocumentResponse> callback)

Moves an existing document associated with one case instance to another case instance.

Parameters:

docReference - Reference to the document in CMIS

sourceCaseReference - Reference to the source case instance

targetCaseReference - Reference to the target case instance

callback - Callback to process the MoveDocumentResponse

Since:

3.1.0

unlinkDocument

public void unlinkDocument(java.lang.String docReference,
                           java.lang.String caseReference,
                           com.google.gwt.user.client.rpc.AsyncCallback<UnlinkDocumentResponse> callback)

UnLinks an existing document from a give case instance. The document is moved into unfiled status in the repository.

Parameters:

docReference - Reference to the document in CMIS

caseReference - Reference to the case instance

callback - Callback to process the UnlinkDocumentResponse

Since:

3.1.0