com.collabnet.ce.soap60.webservices.docman

Interface IDocumentAppSoap

All Known Implementing Classes:

DocumentAppSoapMockStub, DocumentAppSoapStub

public interface IDocumentAppSoap

Provides SOAP web service for document manager application.

Change History

Version 8.1

• getDocumentVersions: New method to list all the versions of a document.
• deleteDocumentByVersions: New method to delete particular version(s) of a document.
• createDocument2: New method to create a document with createDownloadRestricted and allowForceUnlock
  attributes.
• createDocumentWithUrl2: New method to create a document for a URL with createDownloadRestricted and
  allowForceUnlock attributes.
• getDocumentData2: New method to get the document data.
• setDocumentData2: New method to set the document data.
• setDocumentDataWithAssociation2: New method to set the document data with association.
• getDocumentList2: New method to get the list of all documents within a document folder.
• findDocuments2: New method to find a list of documents matching a search string.
• moveDocument2: New method to move a document to a specified target folder.

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.

Version 6.2

• getDocumentFolderList: No Change in the parameters, however now the api returns the following :
  a)When project id is passed with recursive=false, the user obtains only the first matching document folders in the tree from root for which the user has persmission.
  b)When project id is passed with recursive=true, the user obtains all the document folders and descendants for which the user has permission.
  c)When a document folder id is passed with recursive=false, the first matching child folders in the tree from the passed folder for which the user has permission are retrieved.(Not the passed folder)
  d)When a document folder id is passed with recursive=true, the children folders and descendants which the user has permission are retrieved.(Not the passed folder)
  (In Earlier version [i.e prior to CTF6.2] when project id was passed the api would return the document root folder, the current api would return root folder only if the user has permission to the root folder).

Since:

4.1

Method Summary

Modifier and Type	Method and Description
DocumentSoapDO	createDocument(String sessionId, String parentId, String title, String description, String versionComment, String status, boolean createLocked, String fileName, String mimeType, String fileId, String associationId, String associationDesc) Deprecated. in favor of createDocument2
Document2SoapDO	createDocument2(String sessionId, String parentId, String title, String description, String versionComment, String status, boolean createLocked, boolean createDownloadRestricted, boolean allowForceUnlock, String fileName, String mimeType, String fileId, String associationId, String associationDesc) Creates a new document with the specified title, description, etc.
DocumentFolderSoapDO	createDocumentFolder(String sessionId, String parentId, String title, String description) Creates a new document folder with the specified title, description, etc.
DocumentSoapDO	createDocumentWithUrl(String sessionId, String parentId, String title, String description, String versionComment, String status, boolean createLocked, String fileUrl, String associationId, String associationDesc) Deprecated. in favor of createDocumentWithUrl2
Document2SoapDO	createDocumentWithUrl2(String sessionId, String parentId, String title, String description, String versionComment, String status, boolean createLocked, boolean createDownloadRestricted, boolean allowForceUnlock, String fileUrl, String associationId, String associationDesc) Creates a new document with the specified title, description, etc. for a URL with an association.
DocumentReviewSoapDO	createReview(String sessionId, String documentId, int version, String title, String description, Date dueDate, String[] requiredReviewers, String[] optionalReviewers, boolean attachDocument) Creates a document review cycle
void	deleteDocument(String sessionId, String documentId) Deletes a document.Locked document(s) cannot be deleted, When a locked document's id is passed to this API, a SystemFault will be thrown.
void	deleteDocumentByVersions(String sessionId, String documentId, int[] versionNumbers) Deletes particular version(s) of a document.Locked document version(s) cannot be deleted, When a locked document's id is passed to this API, a SystemFault will be thrown.
void	deleteDocumentFolder(String sessionId, String folderId) Deletes a document folder with the specified id.
DocumentSoapList	findDocuments(String sessionId, String queryString, String projectId, boolean searchAttachments, boolean currentVersionsOnly) Deprecated. in favor of findDocuments2
Document2SoapList	findDocuments2(String sessionId, String queryString, String projectId, boolean searchAttachments, boolean currentVersionsOnly) Finds a list of documents matching a search string.
DocumentReviewSoapList	getAssignedDocumentReviewList(String sessionId, String username) Lists all document reviews assigned to a user for review.
DocumentSoapDO	getDocumentData(String sessionId, String documentId, int documentVersion) Deprecated. in favor of getDocumentData2
Document2SoapDO	getDocumentData2(String sessionId, String documentId, int documentVersion) Gets specified document data.
String	getDocumentFileId(String sessionId, String documentId, int documentVersion) Returns a the file id associated with the document file.
DocumentFolderSoapDO	getDocumentFolderData(String sessionId, String folderId) Gets detailed data on a document folder
DocumentFolderSoapList	getDocumentFolderList(String sessionId, String parentId, boolean recursive) Lists document folders.
DocumentSoapList	getDocumentList(String sessionId, String parentId, com.collabnet.ce.soap60.types.SoapFilter[] filters) Deprecated. in favor of getDocumentList2
Document2SoapList	getDocumentList2(String sessionId, String parentId, com.collabnet.ce.soap60.types.SoapFilter[] filters) Lists all documents within a document folder.
DocumentReviewSoapList	getDocumentReviewList(String sessionId, String containerId, com.collabnet.ce.soap60.types.SoapFilter[] filters) Lists all document reviews within a project or a document.
Document2SoapList	getDocumentVersions(String sessionId, String documentId, boolean includeDeletedVersions) Lists all the versions of a document.
DocumentSoapDO	moveDocument(String sessionId, String documentId, String targetFolderId) Deprecated. in favor of moveDocument2
Document2SoapDO	moveDocument2(String sessionId, String documentId, String targetFolderId) Moves a document to a specified target folder.
DocumentFolderSoapDO	moveDocumentFolder(String sessionId, String folderId, String destFolderId) Moves document folder
void	setDocumentData(String sessionId, DocumentSoapDO documentData, String fileId) Deprecated. in favor of setDocumentData2
void	setDocumentData2(String sessionId, Document2SoapDO documentData, String fileId) Sets specified document data.
void	setDocumentDataWithAssociation(String sessionId, DocumentSoapDO documentData, String fileId, String associationId, String associationComment) Deprecated. in favor of setDocumentDataWithAssociation2
void	setDocumentDataWithAssociation2(String sessionId, Document2SoapDO documentData, String fileId, String associationId, String associationComment) Sets specified document data with association.
void	setDocumentFolderData(String sessionId, DocumentFolderSoapDO documentFolderData) Sets detailed data on a document folder

Method Detail

getDocumentFolderList

DocumentFolderSoapList getDocumentFolderList(String sessionId,
                                             String parentId,
                                             boolean recursive)
                                      throws RemoteException

Lists 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. Based on the input parameters the following details are returned:
a)When project id is passed with recursive=false, the user obtains only the first matching document folders in the tree from root for which the user has persmission.
b)When project id is passed with recursive=true, the user obtains all the document folders and descendants for which the user has permission.
c)When a document folder id is passed with recursive=false, the first matching child folders in the tree from the passed folder for which the user has permission are retrieved.(Not the passed folder)
d)When a document folder id is passed with recursive=true, the children folders and descendants which the user has permission are retrieved.(Not the passed folder)

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

RemoteException

Since:

4.1

setDocumentFolderData

void setDocumentFolderData(String sessionId,
                           DocumentFolderSoapDO documentFolderData)
                    throws RemoteException

Sets detailed data on a document folder

Parameters:

sessionId - SOAP session id.

documentFolderData - Data to apply.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id does not exist.

com.collabnet.ce.soap60.fault.VersionMismatchFault - when the specified object has changed in SourceForge.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

RemoteException

Since:

4.2

getDocumentFolderData

DocumentFolderSoapDO getDocumentFolderData(String sessionId,
                                           String folderId)
                                    throws 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.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id does not exist.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when an argument is invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

RemoteException

Since:

4.2

getAssignedDocumentReviewList

DocumentReviewSoapList getAssignedDocumentReviewList(String sessionId,
                                                     String username)
                                              throws 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.collabnet.ce.soap60.fault.InvalidSessionFault - when sessionId is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified user does not exist.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

RemoteException

Since:

4.2

getDocumentReviewList

DocumentReviewSoapList getDocumentReviewList(String sessionId,
                                             String containerId,
                                             com.collabnet.ce.soap60.types.SoapFilter[] filters)
                                      throws 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.collabnet.ce.soap60.fault.InvalidSessionFault - when sessionId is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the document does not exist.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied.

com.collabnet.ce.soap60.fault.InvalidFilterFault - when the specified filters are invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

RemoteException

Since:

4.2

createReview

DocumentReviewSoapDO createReview(String sessionId,
                                  String documentId,
                                  int version,
                                  String title,
                                  String description,
                                  Date dueDate,
                                  String[] requiredReviewers,
                                  String[] optionalReviewers,
                                  boolean attachDocument)
                           throws RemoteException

Creates a document review cycle

Parameters:

sessionId - SOAP session id.

documentId - the id of the document for which the review is to be created.

version - the version of the document

title - The title of the review

description - The description of the review

dueDate - The due date of the review

requiredReviewers - an array of usernames of required reviewers

optionalReviewers - an array of usernames of optional reviewers

attachDocument - whether to attach the document to the email or not

Returns:

The data object of the review

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when sessionId is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when there is no document corresponding to the document Id

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges

com.collabnet.ce.soap60.fault.IllegalArgumentFault - for incorrect arguments. This can happen if the required reviewers array is empty (or) if the username in either required or optional reviewers is not valid (or) a user was specified a both a required reviewer and an optional reviewer (or) The dueDate was a date in the past.

com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - if the review already exists on this document

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

RemoteException

getDocumentList

DocumentSoapList getDocumentList(String sessionId,
                                 String parentId,
                                 com.collabnet.ce.soap60.types.SoapFilter[] filters)
                          throws RemoteException

Deprecated. in favor of getDocumentList2

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).

filters - not supported.

Returns:

Document list.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.InvalidFilterFault - when an invalid filter is specified.

RemoteException

Since:

4.1

getDocumentList2

Document2SoapList getDocumentList2(String sessionId,
                                   String parentId,
                                   com.collabnet.ce.soap60.types.SoapFilter[] filters)
                            throws RemoteException

Lists all documents within a document folder.

Change History

Version 8.1

• downloadRestricted and allowForceUnlock flags were added to Document2SoapRow.

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).

filters - not supported.

Returns:

Document list.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.InvalidFilterFault - when an invalid filter is specified.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

RemoteException

Since:

8.1

findDocuments

DocumentSoapList findDocuments(String sessionId,
                               String queryString,
                               String projectId,
                               boolean searchAttachments,
                               boolean currentVersionsOnly)
                        throws RemoteException

Deprecated. in favor of findDocuments2

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.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified project id is invalid.

com.collabnet.ce.soap60.fault.SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.

RemoteException

Since:

4.1

findDocuments2

Document2SoapList findDocuments2(String sessionId,
                                 String queryString,
                                 String projectId,
                                 boolean searchAttachments,
                                 boolean currentVersionsOnly)
                          throws 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.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified project id is invalid.

com.collabnet.ce.soap60.fault.SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.

RemoteException

Since:

8.1

createDocumentFolder

DocumentFolderSoapDO createDocumentFolder(String sessionId,
                                          String parentId,
                                          String title,
                                          String description)
                                   throws 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.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when a specified object is invalid.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when one or more of the parameters are invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - when the document folder specified already exists.

RemoteException

Since:

4.2

moveDocumentFolder

DocumentFolderSoapDO moveDocumentFolder(String sessionId,
                                        String folderId,
                                        String destFolderId)
                                 throws 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.collabnet.ce.soap60.fault.InvalidSessionFault - sessionId is invalid

com.collabnet.ce.soap60.fault.PermissionDeniedFault - permission is denied for the specified operation

com.collabnet.ce.soap60.fault.NoSuchObjectFault - specified object is invalid

com.collabnet.ce.soap60.fault.SystemFault - unexpected system error

RemoteException

Since:

4.2

deleteDocumentFolder

void deleteDocumentFolder(String sessionId,
                          String folderId)
                   throws RemoteException

Deletes a document folder with the specified id.

Parameters:

sessionId - SOAP session id.

folderId - Folder id to delete.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when one or more of the parameters are invalid.

com.collabnet.ce.soap60.fault.InvalidOperationFault - when attempted to delete top-level document folder.

RemoteException

Since:

4.2

createDocument

DocumentSoapDO createDocument(String sessionId,
                              String parentId,
                              String title,
                              String description,
                              String versionComment,
                              String status,
                              boolean createLocked,
                              String fileName,
                              String mimeType,
                              String fileId,
                              String associationId,
                              String associationDesc)
                       throws RemoteException

Deprecated. in favor of createDocument2

Creates a new document with the specified title, description, etc. If the site is configured to have an association mandatory on document create, then associationId must be specified.

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).

associationId - The id of the object associated, can be set to null if the site is not configured to have association mandatory. The association is set only if the configuration is turned on.

associationDesc - The title of the object associated

Returns:

Document data object.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when one or more of the parameters are invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.InvalidAssociationFault - when an invalid association object is passed.

RemoteException

Since:

4.4-SP1

createDocument2

Document2SoapDO createDocument2(String sessionId,
                                String parentId,
                                String title,
                                String description,
                                String versionComment,
                                String status,
                                boolean createLocked,
                                boolean createDownloadRestricted,
                                boolean allowForceUnlock,
                                String fileName,
                                String mimeType,
                                String fileId,
                                String associationId,
                                String associationDesc)
                         throws RemoteException

Creates a new document with the specified title, description, etc. If the site is configured to have an association mandatory on document create, then associationId must be specified.

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?

createDownloadRestricted - Is document download restricted on create?

allowForceUnlock - Is document admin allowed to edit/download locked document?

Note: createDownloadRestricted and allowForceUnlock can be set to true, only if createLocked is true.

fileName - Name of the file.

mimeType - File mime type.

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

associationId - The id of the object associated, can be set to null if the site is not configured to have association mandatory. The association is set only if the configuration is turned on.

associationDesc - The title of the object associated

Returns:

Document data object.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when one or more of the parameters are invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.InvalidAssociationFault - when an invalid association object is passed.

RemoteException

Since:

8.1

createDocumentWithUrl

DocumentSoapDO createDocumentWithUrl(String sessionId,
                                     String parentId,
                                     String title,
                                     String description,
                                     String versionComment,
                                     String status,
                                     boolean createLocked,
                                     String fileUrl,
                                     String associationId,
                                     String associationDesc)
                              throws RemoteException

Deprecated. in favor of createDocumentWithUrl2

Creates a new document with the specified title, description, etc. for a URL with an association. If the site is configured to have an association mandatory on document create, then associationId must be specified.

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

associationId - id of the object to be associated, can be set to null if the site is not configured to have association mandatory. The association is set only if the configuration is turned on.

associationDesc - association comment

Returns:

Document data object.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when one or more of the parameters are invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.InvalidDocumentContentFault - Only one of fileKey or fileUrl should be set. This failed

com.collabnet.ce.soap60.fault.InvalidAssociationFault - when an invalid association object is passed.

RemoteException

Since:

4.4SP1

createDocumentWithUrl2

Document2SoapDO createDocumentWithUrl2(String sessionId,
                                       String parentId,
                                       String title,
                                       String description,
                                       String versionComment,
                                       String status,
                                       boolean createLocked,
                                       boolean createDownloadRestricted,
                                       boolean allowForceUnlock,
                                       String fileUrl,
                                       String associationId,
                                       String associationDesc)
                                throws RemoteException

Creates a new document with the specified title, description, etc. for a URL with an association. If the site is configured to have an association mandatory on document create, then associationId must be specified.

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?

createDownloadRestricted - Is document download restricted on create?

allowForceUnlock - Is document admin allowed to edit/download locked document?

Note: createDownloadRestricted and allowForceUnlock can be set to true, only if createLocked is true.

fileUrl - the file URL of the document

associationId - id of the object to be associated, can be set to null if the site is not configured to have association mandatory. The association is set only if the configuration is turned on.

associationDesc - association comment

Returns:

Document data object.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when one or more of the parameters are invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.InvalidDocumentContentFault - Only one of fileKey or fileUrl should be set. This failed

com.collabnet.ce.soap60.fault.InvalidAssociationFault - when an invalid association object is passed.

RemoteException

Since:

8.1

moveDocument

DocumentSoapDO moveDocument(String sessionId,
                            String documentId,
                            String targetFolderId)
                     throws RemoteException

Deprecated. in favor of moveDocument2

Moves a document to a specified target folder. Locked documents cannot be moved, When a locked document's id is passed to this API, a SystemFault will be thrown.

Parameters:

sessionId - User session id.

documentId - ID of document to move.

targetFolderId - Target folder ID.

Returns:

New document object.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

RemoteException

Since:

4.2

moveDocument2

Document2SoapDO moveDocument2(String sessionId,
                              String documentId,
                              String targetFolderId)
                       throws RemoteException

Moves a document to a specified target folder. Locked documents cannot be moved, When a locked document's id is passed to this API, a SystemFault will be thrown.

Parameters:

sessionId - User session id.

documentId - ID of document to move.

targetFolderId - Target folder ID.

Returns:

New document object.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

RemoteException

Since:

8.1

deleteDocument

void deleteDocument(String sessionId,
                    String documentId)
             throws RemoteException

Deletes a document.Locked document(s) cannot be deleted, When a locked document's id is passed to this API, a SystemFault will be thrown.

Parameters:

sessionId - User session id.

documentId - Document id.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

RemoteException

Since:

4.1

getDocumentData

DocumentSoapDO getDocumentData(String sessionId,
                               String documentId,
                               int documentVersion)
                        throws RemoteException

Deprecated. in favor of getDocumentData2

Gets 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.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.NoSuchVersionFault - when the specified version is invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

RemoteException

Since:

4.1

getDocumentData2

Document2SoapDO getDocumentData2(String sessionId,
                                 String documentId,
                                 int documentVersion)
                          throws RemoteException

Gets specified document data.

Change History

Version 8.1

• downloadRestricted and allowForceUnlock flags were added to Document2SoapDO.

Version 4.4

• Document2SoapDO.getMimeType() will return null for a document that uses external url, while Document2SoapDO.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.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.NoSuchVersionFault - when the specified version is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

RemoteException

Since:

8.1

setDocumentData

void setDocumentData(String sessionId,
                     DocumentSoapDO documentData,
                     String fileId)
              throws RemoteException

Deprecated. in favor of setDocumentData2

Sets specified document data. To update a document, documentData.getCurrentVersion needs to be set to 0.

Parameters:

sessionId - User session id.

documentData - Document data object.

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

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when document data information is invalid.

com.collabnet.ce.soap60.fault.VersionMismatchFault - when document data is stale.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.InvalidDocumentContentFault - Only one of fileKey or fileUrl should be set. This failed

RemoteException

setDocumentData2

void setDocumentData2(String sessionId,
                      Document2SoapDO documentData,
                      String fileId)
               throws RemoteException

Sets specified document data. To update a document, documentData.getCurrentVersion needs to be set to 0.

Parameters:

sessionId - User session id.

documentData - Document data object.

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

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when document data information is invalid.

com.collabnet.ce.soap60.fault.VersionMismatchFault - when document data is stale.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.InvalidDocumentContentFault - Only one of fileKey or fileUrl should be set. This failed

RemoteException

Since:

8.1

setDocumentDataWithAssociation

void setDocumentDataWithAssociation(String sessionId,
                                    DocumentSoapDO documentData,
                                    String fileId,
                                    String associationId,
                                    String associationComment)
                             throws RemoteException

Deprecated. in favor of setDocumentDataWithAssociation2

Sets specified document data with Association.

Parameters:

sessionId - User session id.

documentData - Document data object.

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

associationId - The id of the association

associationComment - Comment for the association

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when document data information is invalid.

com.collabnet.ce.soap60.fault.VersionMismatchFault - when document data is stale.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.InvalidDocumentContentFault - Only one of fileKey or fileUrl should be set. This failed

com.collabnet.ce.soap60.fault.InvalidAssociationFault - when an invalid association object is passed.

RemoteException

Since:

4.4-SP1

setDocumentDataWithAssociation2

void setDocumentDataWithAssociation2(String sessionId,
                                     Document2SoapDO documentData,
                                     String fileId,
                                     String associationId,
                                     String associationComment)
                              throws RemoteException

Sets specified document data with association.

Parameters:

sessionId - User session id.

documentData - Document data object.

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

associationId - The id of the association

associationComment - Comment for the association

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when document data information is invalid.

com.collabnet.ce.soap60.fault.VersionMismatchFault - when document data is stale.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.InvalidDocumentContentFault - Only one of fileKey or fileUrl should be set. This failed

com.collabnet.ce.soap60.fault.InvalidAssociationFault - when an invalid association object is passed.

RemoteException

Since:

8.1

getDocumentFileId

String getDocumentFileId(String sessionId,
                         String documentId,
                         int documentVersion)
                  throws 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.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.NoSuchVersionFault - when the specified version is invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

RemoteException

Since:

4.1

getDocumentVersions

Document2SoapList getDocumentVersions(String sessionId,
                                      String documentId,
                                      boolean includeDeletedVersions)
                               throws RemoteException

Lists all the versions of a document.

Parameters:

sessionId - SOAP session id.

documentId - Document id.

includeDeletedVersions - Flag to indicate if the deleted versions of the document are to be fetched.

Returns:

Document list.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.InvalidFilterFault - when an invalid filter is specified.

RemoteException

Since:

8.1

deleteDocumentByVersions

void deleteDocumentByVersions(String sessionId,
                              String documentId,
                              int[] versionNumbers)
                       throws RemoteException

Deletes particular version(s) of a document.Locked document version(s) cannot be deleted, When a locked document's id is passed to this API, a SystemFault will be thrown.

Note: Deleted document version(s) cannot be recovered, as they will be permanently deleted from the system.

Parameters:

sessionId - User session id.

documentId - Document id.

versionNumbers - Versions of the document to be deleted

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified document Id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - for incorrect arguments. This can happen if the versionNumbers array is empty (or) if any of the versionNumbers is not valid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.

com.collabnet.ce.soap60.fault.CannotDeleteDocumentVersionFault - when the user tries to delete the active version of the document.

RemoteException

Since:

8.1