com.vasoftware.sf.soap44.webservices.docman
Interface IDocumentAppSoap

public interface IDocumentAppSoap

Provides SOAP web service for document manager application.

Change History

Version 4.4

• setDocumentDataWithUrl: Removed in 4.4. Use DocumentSoapDO.setFileUrl and setDocumentData instead.
• getDocumentFileUrl: Removed in 4.4. Use getDocumentData and call DocumentSoapDO.getFileUrl instead.

Since:

4.1

Method Summary

DocumentSoapDO	createDocument(java.lang.String sessionId, java.lang.String parentId, java.lang.String title, java.lang.String description, java.lang.String versionComment, java.lang.String status, boolean createLocked, java.lang.String fileName, java.lang.String mimeType, java.lang.String fileId) Creates a new document with the specified tile, description, etc.
DocumentFolderSoapDO	createDocumentFolder(java.lang.String sessionId, java.lang.String parentId, java.lang.String title, java.lang.String description) Creates a new document folder with the specified title, description, etc.
DocumentSoapDO	createDocumentWithUrl(java.lang.String sessionId, java.lang.String parentId, java.lang.String title, java.lang.String description, java.lang.String versionComment, java.lang.String status, boolean createLocked, java.lang.String fileUrl) Creates a new document with the specified tile, description, etc.
void	deleteDocument(java.lang.String sessionId, java.lang.String documentId) Deletes a document.
void	deleteDocumentFolder(java.lang.String sessionId, java.lang.String folderId) Deletes a document folder with the specified id.
DocumentSoapList	findDocuments(java.lang.String sessionId, java.lang.String queryString, java.lang.String projectId, boolean searchAttachments, boolean currentVersionsOnly) Finds a list of documents matching a search string.
DocumentReviewSoapList	getAssignedDocumentReviewList(java.lang.String sessionId, java.lang.String username) Lists all document reviews assigned to a user for review.
DocumentSoapDO	getDocumentData(java.lang.String sessionId, java.lang.String documentId, int documentVersion) Get specified document data.
java.lang.String	getDocumentFileId(java.lang.String sessionId, java.lang.String documentId, int documentVersion) Returns a the file id associated with the document file.
DocumentFolderSoapDO	getDocumentFolderData(java.lang.String sessionId, java.lang.String folderId) Gets detailed data on a document folder
DocumentFolderSoapList	getDocumentFolderList(java.lang.String sessionId, java.lang.String parentId, boolean recursive) List document folders.
DocumentSoapList	getDocumentList(java.lang.String sessionId, java.lang.String parentId, SoapFilter[] filters) Lists all documents within a document folder.
DocumentReviewSoapList	getDocumentReviewList(java.lang.String sessionId, java.lang.String containerId, SoapFilter[] filters) Lists all document reviews within a project or a document.
DocumentSoapDO	moveDocument(java.lang.String sessionId, java.lang.String documentId, java.lang.String targetFolderId) Moves a document to a specified target folder.
DocumentFolderSoapDO	moveDocumentFolder(java.lang.String sessionId, java.lang.String folderId, java.lang.String destFolderId) Moves document folder
void	setDocumentData(java.lang.String sessionId, DocumentSoapDO documentData, java.lang.String fileId) Sets specified document data.
void	setDocumentFolderData(java.lang.String sessionId, DocumentFolderSoapDO documentFolderData) Sets detailed data on a document folder

Method Detail

getDocumentFolderList

DocumentFolderSoapList getDocumentFolderList(java.lang.String sessionId,
                                             java.lang.String parentId,
                                             boolean recursive)
                                             throws java.rmi.RemoteException

List document folders.

Parameters:

sessionId - SOAP session id.

parentId - Parent document folder id -or- project id for listing root document folder.

recursive - Show subfolders of the folders returned

Returns:

Document folder list.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.1

setDocumentFolderData

void setDocumentFolderData(java.lang.String sessionId,
                           DocumentFolderSoapDO documentFolderData)
                           throws java.rmi.RemoteException

Sets detailed data on a document folder

Parameters:

sessionId - SOAP session id.

documentFolderData - Data to apply.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id does not exist.

com.vasoftware.sf.soap44.fault.VersionMismatchFault - when the specified object has changed in SourceForge.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when an argument is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.2

getDocumentFolderData

DocumentFolderSoapDO getDocumentFolderData(java.lang.String sessionId,
                                           java.lang.String folderId)
                                           throws java.rmi.RemoteException

Gets detailed data on a document folder

Parameters:

sessionId - SOAP session id.

folderId - Folder id to get detailed data for.

Returns:

Document Folder data object.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id does not exist.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when an argument is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.2

getAssignedDocumentReviewList

DocumentReviewSoapList getAssignedDocumentReviewList(java.lang.String sessionId,
                                                     java.lang.String username)
                                                     throws java.rmi.RemoteException

Lists all document reviews assigned to a user for review.

Parameters:

sessionId - SOAP session id.

username - User to whom reviews are assigned for review (required or optional).

Returns:

Document review list.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when sessionId is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified user does not exist.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permission is denied.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.2

getDocumentReviewList

DocumentReviewSoapList getDocumentReviewList(java.lang.String sessionId,
                                             java.lang.String containerId,
                                             SoapFilter[] filters)
                                             throws java.rmi.RemoteException

Lists all document reviews within a project or a document. The following are the only permitted combinations:

• containerId=null, filters=(createdBy="username" AND status="open"}: Returns all open reviews created by the user.
• containerId=documentId, filters=null: Returns a list of reviews (open and closed) for the document.

Parameters:

sessionId - SOAP session id.

containerId - null (for reviews across projects) or document ID (for reviews associated with document).

filters - Filters to apply for listing the reviews.

Returns:

Document review list.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when sessionId is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the document does not exist.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permission is denied.

com.vasoftware.sf.soap44.fault.InvalidFilterFault - when the specified filters are invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.2

getDocumentList

DocumentSoapList getDocumentList(java.lang.String sessionId,
                                 java.lang.String parentId,
                                 SoapFilter[] filters)
                                 throws java.rmi.RemoteException

Lists all documents within a document folder.

Change History

Version 4.2

• Added additional parameter filters for future use. Must be null or empty for now.

Parameters:

sessionId - SOAP session id.

parentId - Document folder id (obtained from getDocumentFolderList).

Returns:

Document list.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

com.vasoftware.sf.soap44.fault.InvalidFilterFault - when an invalid filter is specified.

java.rmi.RemoteException

Since:

4.1

findDocuments

DocumentSoapList findDocuments(java.lang.String sessionId,
                               java.lang.String queryString,
                               java.lang.String projectId,
                               boolean searchAttachments,
                               boolean currentVersionsOnly)
                               throws java.rmi.RemoteException

Finds a list of documents matching a search string.

Parameters:

sessionId - User session id.

queryString - Query string.

projectId - The project in which to find documents. (if null, search all projects)

searchAttachments - Whether to search attachments.

currentVersionsOnly - Whether to search only current versions of documents.

Returns:

List of documents matching search criteria.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified project id is invalid.

com.vasoftware.sf.soap44.fault.SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

java.rmi.RemoteException

Since:

4.1

createDocumentFolder

DocumentFolderSoapDO createDocumentFolder(java.lang.String sessionId,
                                          java.lang.String parentId,
                                          java.lang.String title,
                                          java.lang.String description)
                                          throws java.rmi.RemoteException

Creates a new document folder with the specified title, description, etc.

Parameters:

sessionId - SOAP session id.

parentId - Folder id in which to create this folder.

title - Document folder title.

description - Document folder description.

Returns:

Document Folder data object.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when a specified object is invalid.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when one or more of the parameters are invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

com.vasoftware.sf.soap44.fault.ObjectAlreadyExistsFault - when the document folder specified already exists.

java.rmi.RemoteException

Since:

4.2

moveDocumentFolder

DocumentFolderSoapDO moveDocumentFolder(java.lang.String sessionId,
                                        java.lang.String folderId,
                                        java.lang.String destFolderId)
                                        throws java.rmi.RemoteException

Moves document folder

Parameters:

sessionId - SOAP session id.

folderId - ID of folder to move.

destFolderId - ID of destination folder

Returns:

new document folder

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - sessionId is invalid

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - permission is denied for the specified operation

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - specified object is invalid

com.vasoftware.sf.soap44.fault.SystemFault - unexpected system error

java.rmi.RemoteException

Since:

4.2

deleteDocumentFolder

void deleteDocumentFolder(java.lang.String sessionId,
                          java.lang.String folderId)
                          throws java.rmi.RemoteException

Deletes a document folder with the specified id.

Parameters:

sessionId - SOAP session id.

folderId - Folder id to delete.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object is invalid

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when one or more of the parameters are invalid.

java.rmi.RemoteException

Since:

4.2

createDocument

DocumentSoapDO createDocument(java.lang.String sessionId,
                              java.lang.String parentId,
                              java.lang.String title,
                              java.lang.String description,
                              java.lang.String versionComment,
                              java.lang.String status,
                              boolean createLocked,
                              java.lang.String fileName,
                              java.lang.String mimeType,
                              java.lang.String fileId)
                              throws java.rmi.RemoteException

Creates a new document with the specified tile, description, etc.

Parameters:

sessionId - SOAP session id.

parentId - Document folder id in which to create a document.

title - Document title.

description - Document description.

versionComment - Document version comment.

status - Document status.

createLocked - Is document locked on create?

fileName - Name of the file.

mimeType - File mime type.

fileId - Uploaded file id (through FileStorageApp or SimpleFileStorageApp service).

Returns:

Document data object.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object is invalid.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when one or more of the parameters are invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.1

createDocumentWithUrl

DocumentSoapDO createDocumentWithUrl(java.lang.String sessionId,
                                     java.lang.String parentId,
                                     java.lang.String title,
                                     java.lang.String description,
                                     java.lang.String versionComment,
                                     java.lang.String status,
                                     boolean createLocked,
                                     java.lang.String fileUrl)
                                     throws java.rmi.RemoteException

Creates a new document with the specified tile, description, etc.

Parameters:

sessionId - SOAP session id.

parentId - Document folder id in which to create a document.

title - Document title.

description - Document description.

versionComment - Document version comment.

status - Document status.

createLocked - Is document locked on create?

fileUrl - the file URL of the document

Returns:

Document data object.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object is invalid.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when one or more of the parameters are invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

com.vasoftware.sf.soap44.fault.InvalidDocumentContentFault - Only one of fileKey or fileUrl should be set. This failed

java.rmi.RemoteException

Since:

4.3-HOTFIX6

moveDocument

DocumentSoapDO moveDocument(java.lang.String sessionId,
                            java.lang.String documentId,
                            java.lang.String targetFolderId)
                            throws java.rmi.RemoteException

Moves a document to a specified target folder.

Parameters:

sessionId - User session id.

documentId - ID of document to move.

targetFolderId - Target folder ID.

Returns:

New document object.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.2

deleteDocument

void deleteDocument(java.lang.String sessionId,
                    java.lang.String documentId)
                    throws java.rmi.RemoteException

Deletes a document.

Parameters:

sessionId - User session id.

documentId - Document id.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.1

getDocumentData

DocumentSoapDO getDocumentData(java.lang.String sessionId,
                               java.lang.String documentId,
                               int documentVersion)
                               throws java.rmi.RemoteException

Get specified document data.

Change History

Version 4.4

• DocumentSoapDO.getMimeType() will return null for a document that uses external url, while DocumentSoapDO.getFileUrl() will allow direct access of file url without making a separate call.

Parameters:

sessionId - User session id.

documentId - Document id.

documentVersion - Document version number (specify zero for current version).

Returns:

Document data object.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object is invalid.

com.vasoftware.sf.soap44.fault.NoSuchVersionFault - when the specified version is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.1

setDocumentData

void setDocumentData(java.lang.String sessionId,
                     DocumentSoapDO documentData,
                     java.lang.String fileId)
                     throws java.rmi.RemoteException

Sets specified document data.

Parameters:

sessionId - User session id.

documentData - Document data object.

fileId - Uploaded file id (through FileStorageApp or SimpleFileStorageApp service).

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object is invalid.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when document data information is invalid.

com.vasoftware.sf.soap44.fault.VersionMismatchFault - when document data is stale.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

com.vasoftware.sf.soap44.fault.InvalidDocumentContentFault - Only one of fileKey or fileUrl should be set. This failed

java.rmi.RemoteException

getDocumentFileId

java.lang.String getDocumentFileId(java.lang.String sessionId,
                                   java.lang.String documentId,
                                   int documentVersion)
                                   throws java.rmi.RemoteException

Returns a the file id associated with the document file. The returned file id should be used with one of the file storage services to download the file (e.g. FileStorageApp or SimpleFileStorageApp service).
IMPORTANT: The returned file id is valid ONLY during the session.

Parameters:

sessionId - User session id.

documentId - document id.

documentVersion - document version number (specify zero for current version).

Returns:

File storage id (for download using FileStorageService or SimpleFileStorageService).

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object is invalid.

com.vasoftware.sf.soap44.fault.NoSuchVersionFault - when the specified version is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.1