DocumentAppSoapStub (SOAP API - Version 60 17.1.524 API)

java.lang.Object
- com.collabnet.ce.soap60.webservices.ClientSoapStub
- - com.collabnet.ce.soap60.webservices.docman.DocumentAppSoapStub

All Implemented Interfaces:: IDocumentAppSoap

public class DocumentAppSoapStub
extends com.collabnet.ce.soap60.webservices.ClientSoapStub
implements IDocumentAppSoap

Field Summary
- Fields inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
  DEFAULT_CLIENT_TIME_OUT

Constructor Summary

Constructors
Constructor and Description

DocumentAppSoapStub(String soapServerUrl)

Constructors
Constructor and Description
`DocumentAppSoapStub(String soapServerUrl)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDateField(String sessionId, String projectId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String helpText)` Adds a custom Date field to documents.
`void`	`addMultiSelectField(String sessionId, String projectId, String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String[] defaultValues, String helpText)` Adds a custom multi select field to documents.
`void`	`addSeparator(String sessionId, String projectId, String separatorType, String separatorLabel)` Adds a separator to a document root folder.
`void`	`addSingleSelectChildField(String sessionId, String projectId, String fieldName, String[] fieldValues, String parentFieldId, com.collabnet.ce.soap60.types.SoapNamedValues parentChildFieldValueMap, String helpText)` Adds a custom single select field to documents.
`void`	`addSingleSelectField(String sessionId, String projectId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String defaultValue, String helpText)` Adds a custom single select field to documents.
`void`	`addTextField(String sessionId, String projectId, String fieldName, int displayColumns, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String defaultValue, String helpText, String pattern)` Adds a custom text field to documents.
`void`	`addUserSelectField(String sessionId, String projectId, String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] defaultValues, String userFilter, String helpText)` Adds a custom User selection field to documents.
`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)` Creates a new document with the specified title, description, etc.
`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.
`Document3SoapDO`	`createDocument3(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, com.collabnet.ce.soap60.types.SoapFieldValues flexFields)` 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)` Creates a new document with the specified title, description, etc. for a URL with an association.
`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.
`Document3SoapDO`	`createDocumentWithUrl3(String sessionId, String parentId, String title, String description, String versionComment, String status, boolean createLocked, boolean createDownloadRestricted, boolean allowForceUnlock, String fileUrl, String associationId, String associationDesc, com.collabnet.ce.soap60.types.SoapFieldValues flexFields)` 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.
`void`	`deleteField(String sessionId, String fieldId)` Deletes a custom/flex-field.
`void`	`deleteSeparator(String sessionId, String layoutId)` Deletes a separator of a document root folder layout.
`DocumentSoapList`	`findDocuments(String sessionId, String queryString, String projectId, boolean searchAttachments, boolean currentVersionsOnly)` Finds a list of documents matching a search string.
`Document2SoapList`	`findDocuments2(String sessionId, String queryString, String projectId, boolean searchAttachments, boolean currentVersionsOnly)` Finds a list of documents matching a search string.
`Document3SoapList`	`findDocuments3(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)` Gets specified document data.
`Document2SoapDO`	`getDocumentData2(String sessionId, String documentId, int documentVersion)` Gets specified document data.
`Document3SoapDO`	`getDocumentData3(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)` Lists all documents within a document folder.
`Document2SoapList`	`getDocumentList2(String sessionId, String parentId, com.collabnet.ce.soap60.types.SoapFilter[] filters)` Lists all documents within a document folder.
`Document3SoapList`	`getDocumentList3(String sessionId, String documentFolderId, 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.
`DocumentFolderFieldSoapDO[]`	`getFields(String sessionId, String projectId)` Returns the custom/flex-fields associated with the given project's document root folder.
`OrderedDocumentFolderFieldSoapList`	`getOrderedDocumentFields(String sessionId, String projectId)` Returns all the custom/flex-fields and the separators associated with the given project's document root folder with layout information.
`DocumentSoapDO`	`moveDocument(String sessionId, String documentId, String targetFolderId)` Moves a document to a specified target folder.
`Document2SoapDO`	`moveDocument2(String sessionId, String documentId, String targetFolderId)` Moves a document to a specified target folder.
`Document3SoapDO`	`moveDocument3(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`	`reorderDocumentFields(String sessionId, String projectId, String[] layoutIds)` Sets a new order of the fields and the separators within the given project's document root folder.
`void`	`setDocumentData(String sessionId, DocumentSoapDO documentData, String fileId)` Sets specified document data.
`void`	`setDocumentData2(String sessionId, Document2SoapDO documentData, String fileId)` Sets specified document data.
`void`	`setDocumentData3(String sessionId, Document3SoapDO documentData, String fileId)` Sets specified document data.
`void`	`setDocumentDataWithAssociation(String sessionId, DocumentSoapDO documentData, String fileId, String associationId, String associationComment)` Sets specified document data with Association.
`void`	`setDocumentDataWithAssociation2(String sessionId, Document2SoapDO documentData, String fileId, String associationId, String associationComment)` Sets specified document data with association.
`void`	`setDocumentDataWithAssociation3(String sessionId, Document3SoapDO 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
`void`	`setField(String sessionId, DocumentFolderFieldSoapDO fieldData)` Sets a custom/flex-field.

Methods inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
getServiceCall, getSoapServer, getTimeout, setTimeout

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DocumentAppSoapStub
```
public DocumentAppSoapStub(String soapServerUrl)
```
- Method Detail
  - getDocumentFolderList
```
public DocumentFolderSoapList getDocumentFolderList(String sessionId,
                                                    String parentId,
                                                    boolean recursive)
                                             throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Lists document folders.
    
    Specified by:
    
    getDocumentFolderList in interface IDocumentAppSoap
    
    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
  - setDocumentFolderData
```
public void setDocumentFolderData(String sessionId,
                                  DocumentFolderSoapDO documentFolderData)
                           throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Sets detailed data on a document folder
    
    Specified by:
    
    setDocumentFolderData in interface IDocumentAppSoap
    
    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
  - getDocumentFolderData
```
public DocumentFolderSoapDO getDocumentFolderData(String sessionId,
                                                  String folderId)
                                           throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Gets detailed data on a document folder
    
    Specified by:
    
    getDocumentFolderData in interface IDocumentAppSoap
    
    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
  - getAssignedDocumentReviewList
```
public DocumentReviewSoapList getAssignedDocumentReviewList(String sessionId,
                                                            String username)
                                                     throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Lists all document reviews assigned to a user for review.
    
    Specified by:
    
    getAssignedDocumentReviewList in interface IDocumentAppSoap
    
    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
  - getDocumentReviewList
```
public DocumentReviewSoapList getDocumentReviewList(String sessionId,
                                                    String containerId,
                                                    com.collabnet.ce.soap60.types.SoapFilter[] filters)
                                             throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    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.
    Specified by:
    
    getDocumentReviewList in interface IDocumentAppSoap
    
    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
  - createReview
```
public DocumentReviewSoapDO createReview(String sessionId,
                                         String documentId,
                                         int version,
                                         String title,
                                         String description,
                                         Date dueDate,
                                         String[] requiredReviewers,
                                         String[] optionalReviewers,
                                         boolean attachDocument)
                                  throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Creates a document review cycle
    
    Specified by:
    
    createReview in interface IDocumentAppSoap
    
    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
```
public DocumentSoapList getDocumentList(String sessionId,
                                        String parentId,
                                        com.collabnet.ce.soap60.types.SoapFilter[] filters)
                                 throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    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.
    Specified by:
    
    getDocumentList in interface IDocumentAppSoap
    
    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
  - getDocumentList2
```
public Document2SoapList getDocumentList2(String sessionId,
                                          String parentId,
                                          com.collabnet.ce.soap60.types.SoapFilter[] filters)
                                   throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    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.
    Specified by:
    
    getDocumentList2 in interface IDocumentAppSoap
    
    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
  - getDocumentList3
```
public Document3SoapList getDocumentList3(String sessionId,
                                          String documentFolderId,
                                          com.collabnet.ce.soap60.types.SoapFilter[] filters)
                                   throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    Lists all documents within a document folder.
    Change History
    
    Version 17.1
    - This method now returns data for all flex fields, whether they have values or not. Flex fields with no values will have NULL values in the values[] array.
    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.
    Specified by:
    
    getDocumentList3 in interface IDocumentAppSoap
    
    Parameters:
    
    sessionId - SOAP session id.
    
    documentFolderId - 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
  - findDocuments
```
public DocumentSoapList findDocuments(String sessionId,
                                      String queryString,
                                      String projectId,
                                      boolean searchAttachments,
                                      boolean currentVersionsOnly)
                               throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Finds a list of documents matching a search string.
    
    Specified by:
    
    findDocuments in interface IDocumentAppSoap
    
    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
  - findDocuments2
```
public Document2SoapList findDocuments2(String sessionId,
                                        String queryString,
                                        String projectId,
                                        boolean searchAttachments,
                                        boolean currentVersionsOnly)
                                 throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Finds a list of documents matching a search string.
    
    Specified by:
    
    findDocuments2 in interface IDocumentAppSoap
    
    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
  - findDocuments3
```
public Document3SoapList findDocuments3(String sessionId,
                                        String queryString,
                                        String projectId,
                                        boolean searchAttachments,
                                        boolean currentVersionsOnly)
                                 throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Finds a list of documents matching a search string.
    
    Specified by:
    
    findDocuments3 in interface IDocumentAppSoap
    
    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.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - when the specified query string is invalid.
    
    RemoteException
  - createDocumentFolder
```
public DocumentFolderSoapDO createDocumentFolder(String sessionId,
                                                 String parentId,
                                                 String title,
                                                 String description)
                                          throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Creates a new document folder with the specified title, description, etc.
    
    Specified by:
    
    createDocumentFolder in interface IDocumentAppSoap
    
    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
  - moveDocumentFolder
```
public DocumentFolderSoapDO moveDocumentFolder(String sessionId,
                                               String folderId,
                                               String destFolderId)
                                        throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Moves document folder
    
    Specified by:
    
    moveDocumentFolder in interface IDocumentAppSoap
    
    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
  - deleteDocumentFolder
```
public void deleteDocumentFolder(String sessionId,
                                 String folderId)
                          throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Deletes a document folder with the specified id.
    
    Specified by:
    
    deleteDocumentFolder in interface IDocumentAppSoap
    
    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
  - createDocument
```
public 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
```
    Description copied from interface: IDocumentAppSoap
    
    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.
    
    Specified by:
    
    createDocument in interface IDocumentAppSoap
    
    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
  - createDocument2
```
public 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
```
    Description copied from interface: IDocumentAppSoap
    
    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.
    
    Specified by:
    
    createDocument2 in interface IDocumentAppSoap
    
    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
  - createDocument3
```
public Document3SoapDO createDocument3(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,
                                       com.collabnet.ce.soap60.types.SoapFieldValues flexFields)
                                throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    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.
    
    Specified by:
    
    createDocument3 in interface IDocumentAppSoap
    
    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
    
    flexFields - Flex field values
    
    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.
    
    com.collabnet.ce.soap60.fault.WorkflowViolationFault - when the workflow is violated.
    
    RemoteException
  - createDocumentWithUrl
```
public DocumentSoapDO createDocumentWithUrl(String sessionId,
                                            String parentId,
                                            String title,
                                            String description,
                                            String versionComment,
                                            String status,
                                            boolean createLocked,
                                            String fileUrl,
                                            String associationId,
                                            String associationDesc)
                                     throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    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.
    
    Specified by:
    
    createDocumentWithUrl in interface IDocumentAppSoap
    
    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
  - createDocumentWithUrl2
```
public 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
```
    Description copied from interface: IDocumentAppSoap
    
    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.
    
    Specified by:
    
    createDocumentWithUrl2 in interface IDocumentAppSoap
    
    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
  - createDocumentWithUrl3
```
public Document3SoapDO createDocumentWithUrl3(String sessionId,
                                              String parentId,
                                              String title,
                                              String description,
                                              String versionComment,
                                              String status,
                                              boolean createLocked,
                                              boolean createDownloadRestricted,
                                              boolean allowForceUnlock,
                                              String fileUrl,
                                              String associationId,
                                              String associationDesc,
                                              com.collabnet.ce.soap60.types.SoapFieldValues flexFields)
                                       throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    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.
    
    Specified by:
    
    createDocumentWithUrl3 in interface IDocumentAppSoap
    
    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
    
    flexFields - Flex field values
    
    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.
    
    com.collabnet.ce.soap60.fault.WorkflowViolationFault - when the workflow is violated.
    
    RemoteException
  - moveDocument
```
public DocumentSoapDO moveDocument(String sessionId,
                                   String documentId,
                                   String targetFolderId)
                            throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    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.
    
    Specified by:
    
    moveDocument in interface IDocumentAppSoap
    
    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
  - moveDocument2
```
public Document2SoapDO moveDocument2(String sessionId,
                                     String documentId,
                                     String targetFolderId)
                              throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    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.
    
    Specified by:
    
    moveDocument2 in interface IDocumentAppSoap
    
    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
  - moveDocument3
```
public Document3SoapDO moveDocument3(String sessionId,
                                     String documentId,
                                     String targetFolderId)
                              throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    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.
    
    Specified by:
    
    moveDocument3 in interface IDocumentAppSoap
    
    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.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - when one or more of the parameters are invalid.
    
    RemoteException
  - deleteDocument
```
public void deleteDocument(String sessionId,
                           String documentId)
                    throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    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.
    
    Specified by:
    
    deleteDocument in interface IDocumentAppSoap
    
    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
  - getDocumentData
```
public DocumentSoapDO getDocumentData(String sessionId,
                                      String documentId,
                                      int documentVersion)
                               throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    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.
    Specified by:
    
    getDocumentData in interface IDocumentAppSoap
    
    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
  - getDocumentData2
```
public Document2SoapDO getDocumentData2(String sessionId,
                                        String documentId,
                                        int documentVersion)
                                 throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    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.
    Specified by:
    
    getDocumentData2 in interface IDocumentAppSoap
    
    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
  - getDocumentData3
```
public Document3SoapDO getDocumentData3(String sessionId,
                                        String documentId,
                                        int documentVersion)
                                 throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Gets specified document data.
    
    Specified by:
    
    getDocumentData3 in interface IDocumentAppSoap
    
    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
  - setDocumentData
```
public void setDocumentData(String sessionId,
                            DocumentSoapDO documentData,
                            String fileId)
                     throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Sets specified document data. To update a document, documentData.getCurrentVersion needs to be set to 0.
    
    Specified by:
    
    setDocumentData in interface IDocumentAppSoap
    
    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
```
public void setDocumentData2(String sessionId,
                             Document2SoapDO documentData,
                             String fileId)
                      throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Sets specified document data. To update a document, documentData.getCurrentVersion needs to be set to 0.
    
    Specified by:
    
    setDocumentData2 in interface IDocumentAppSoap
    
    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
  - setDocumentData3
```
public void setDocumentData3(String sessionId,
                             Document3SoapDO documentData,
                             String fileId)
                      throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Sets specified document data. To update a document, documentData.getCurrentVersion needs to be set to 0.
    
    Specified by:
    
    setDocumentData3 in interface IDocumentAppSoap
    
    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
    
    com.collabnet.ce.soap60.fault.WorkflowViolationFault - when the workflow is violated
    
    RemoteException
  - setDocumentDataWithAssociation
```
public void setDocumentDataWithAssociation(String sessionId,
                                           DocumentSoapDO documentData,
                                           String fileId,
                                           String associationId,
                                           String associationComment)
                                    throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Sets specified document data with Association.
    
    Specified by:
    
    setDocumentDataWithAssociation in interface IDocumentAppSoap
    
    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
  - setDocumentDataWithAssociation2
```
public void setDocumentDataWithAssociation2(String sessionId,
                                            Document2SoapDO documentData,
                                            String fileId,
                                            String associationId,
                                            String associationComment)
                                     throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Sets specified document data with association.
    
    Specified by:
    
    setDocumentDataWithAssociation2 in interface IDocumentAppSoap
    
    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
  - setDocumentDataWithAssociation3
```
public void setDocumentDataWithAssociation3(String sessionId,
                                            Document3SoapDO documentData,
                                            String fileId,
                                            String associationId,
                                            String associationComment)
                                     throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    Sets specified document data with association.
    
    Specified by:
    
    setDocumentDataWithAssociation3 in interface IDocumentAppSoap
    
    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.
    
    com.collabnet.ce.soap60.fault.WorkflowViolationFault - when the workflow is violated
    
    RemoteException
  - getDocumentFileId
```
public String getDocumentFileId(String sessionId,
                                String documentId,
                                int documentVersion)
                         throws RemoteException
```
    Description copied from interface: IDocumentAppSoap
    
    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.
    
    Specified by:
    
    getDocumentFileId in interface IDocumentAppSoap
    
    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
  getDocumentVersions
  
  public Document2SoapList getDocumentVersions(String sessionId, String documentId, boolean includeDeletedVersions) throws RemoteException
  
  Description copied from interface: IDocumentAppSoap
  
  Lists all the versions of a document.
  
  Specified by:
  
  getDocumentVersions in interface IDocumentAppSoap
  
  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
  
  deleteDocumentByVersions
  
  public void deleteDocumentByVersions(String sessionId, String documentId, int[] versionNumbers) throws RemoteException
  
  Description copied from interface: IDocumentAppSoap
  
  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.
  
  Specified by:
  
  deleteDocumentByVersions in interface IDocumentAppSoap
  
  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
  
  addTextField
  
  public void addTextField(String sessionId, String projectId, String fieldName, int displayColumns, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String defaultValue, String helpText, String pattern) throws RemoteException
  
  Description copied from interface: IDocumentAppSoap
  
  Adds a custom text field to documents.
  
  Specified by:
  
  addTextField in interface IDocumentAppSoap
  
  Parameters:
  
  sessionId - User session id.
  
  projectId - The project in which to add the field to.
  
  fieldName - the name of the field
  
  displayColumns - the width of the display area
  
  displayLines - the height of the display area
  
  isRequired - if the field is required
  
  isDisabled - if the field is disabled
  
  isHiddenOnCreate - if the field is hidden when first created
  
  defaultValue - default value
  
  helpText - The help text for the field
  
  pattern - The field validation pattern
  
  Throws:
  
  com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid
  
  com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
  
  com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
  
  com.collabnet.ce.soap60.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched
  
  com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified
  
  com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed
  
  com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
  
  RemoteException
  
  addSingleSelectChildField
  
  public void addSingleSelectChildField(String sessionId, String projectId, String fieldName, String[] fieldValues, String parentFieldId, com.collabnet.ce.soap60.types.SoapNamedValues parentChildFieldValueMap, String helpText) throws RemoteException
  
  Description copied from interface: IDocumentAppSoap
  
  Adds a custom single select field to documents.
  
  Specified by:
  
  addSingleSelectChildField in interface IDocumentAppSoap
  
  Parameters:
  
  sessionId - User session id.
  
  projectId - The project in which to add the field to.
  
  fieldName - the name of the field
  
  fieldValues - Array of valid field values
  
  parentFieldId - The id of the parent field
  
  parentChildFieldValueMap - soapNamedValues which keeps mapping between parent field values and child values
  
  helpText - the help text for the field
  
  Throws:
  
  com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid
  
  com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
  
  com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
  
  com.collabnet.ce.soap60.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched
  
  com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified
  
  com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed
  
  com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
  
  RemoteException
  
  addSingleSelectField
  
  public void addSingleSelectField(String sessionId, String projectId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String defaultValue, String helpText) throws RemoteException
  
  Description copied from interface: IDocumentAppSoap
  
  Adds a custom single select field to documents.
  
  Specified by:
  
  addSingleSelectField in interface IDocumentAppSoap
  
  Parameters:
  
  sessionId - User session id.
  
  projectId - The project in which to add the field to.
  
  fieldName - the name of the field
  
  isRequired - if the field is required
  
  isDisabled - if the field is disabled
  
  isHiddenOnCreate - if the field is hidden when first created
  
  fieldValues - Array of valid field values
  
  defaultValue - default value
  
  helpText - the help text for the field
  
  Throws:
  
  com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid
  
  com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
  
  com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
  
  com.collabnet.ce.soap60.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched
  
  com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified
  
  com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed
  
  com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
  
  RemoteException
  
  addMultiSelectField
  
  public void addMultiSelectField(String sessionId, String projectId, String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String[] defaultValues, String helpText) throws RemoteException
  
  Description copied from interface: IDocumentAppSoap
  
  Adds a custom multi select field to documents.
  
  Specified by:
  
  addMultiSelectField in interface IDocumentAppSoap
  
  Parameters:
  
  sessionId - User session id.
  
  projectId - The project in which to add the field to.
  
  fieldName - the name of the field
  
  displayLines - the height of the display area
  
  isRequired - if the field is required
  
  isDisabled - if the field is disabled
  
  isHiddenOnCreate - if the field is hidden when first created
  
  fieldValues - possible values
  
  defaultValues - default values
  
  helpText - the help text for the field
  
  Throws:
  
  com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid
  
  com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
  
  com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
  
  com.collabnet.ce.soap60.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched
  
  com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified
  
  com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed
  
  com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
  
  RemoteException
  
  addUserSelectField
  
  public void addUserSelectField(String sessionId, String projectId, String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] defaultValues, String userFilter, String helpText) throws RemoteException
  
  Description copied from interface: IDocumentAppSoap
  
  Adds a custom User selection field to documents.
  
  Specified by:
  
  addUserSelectField in interface IDocumentAppSoap
  
  Parameters:
  
  sessionId - User session id.
  
  projectId - The project in which to add the field to.
  
  fieldName - the name of the field
  
  displayLines - the height of the display area
  
  isRequired - if the field is required
  
  isDisabled - if the field is disabled
  
  isHiddenOnCreate - if the field is hidden when first created
  
  defaultValues - default values for this field. Must be valid usernames
  
  userFilter - is the filter
  
  helpText - The help text of the field
  
  Throws:
  
  com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid
  
  com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
  
  com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
  
  com.collabnet.ce.soap60.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched
  
  com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified
  
  com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed
  
  com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
  
  RemoteException
  
  See Also:
  
  DocumentFieldSoapDO#FIELD_USER_FILTER_PROJECT_MEMBER, DocumentFieldSoapDO#FIELD_USER_FILTER_ALL
  
  addDateField
  
  public void addDateField(String sessionId, String projectId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String helpText) throws RemoteException
  
  Description copied from interface: IDocumentAppSoap
  
  Adds a custom Date field to documents.
  
  Specified by:
  
  addDateField in interface IDocumentAppSoap
  
  Parameters:
  
  sessionId - User session id.
  
  projectId - The project in which to add the field to.
  
  fieldName - the name of the field
  
  isRequired - if the field is required
  
  isDisabled - if the field is disabled
  
  isHiddenOnCreate - if the field is hidden when first created
  
  helpText - the help text of the field
  
  Throws:
  
  com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid
  
  com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
  
  com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
  
  com.collabnet.ce.soap60.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched
  
  com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified
  
  com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed
  
  com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
  
  RemoteException
  
  getFields
  
  public DocumentFolderFieldSoapDO[] getFields(String sessionId, String projectId) throws RemoteException
  
  Description copied from interface: IDocumentAppSoap
  
  Returns the custom/flex-fields associated with the given project's document root folder.
  
  Specified by:
  
  getFields in interface IDocumentAppSoap
  
  Parameters:
  
  sessionId - User session id.
  
  projectId - The project for which to return the document fields information.
  
  Returns:
  
  Array of all field values.
  
  Throws:
  
  com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
  
  com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
  
  com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
  
  com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
  
  RemoteException
  
  setField
  
  public void setField(String sessionId, DocumentFolderFieldSoapDO fieldData) throws RemoteException
  
  Description copied from interface: IDocumentAppSoap
  
  Sets a custom/flex-field.
  
  Specified by:
  
  setField in interface IDocumentAppSoap
  
  Parameters:
  
  sessionId - User session id.
  
  fieldData - the custom/flex-field to associate with a specific folder
  
  Throws:
  
  com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid
  
  com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
  
  com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
  
  com.collabnet.ce.soap60.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched
  
  com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified. See FaultSummary for detail for the following: - DUPLICATE_FIELD_VALUE - ILLEGAL_FIELD_VALUE - INVALID_FIELD_VALUE - INVALID_DEFAULT_VALUE - INVALID_FIELD_OPTIONS_REQUIRED_DISABLED - INVALID_FIELD_VALUE_LENGTH - REQUIRED_FIELD_MISSING - INVALID_FIELD_PATTERN
  
  com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed. See FaultSummary for detail for the following: - INVALID_OPTION_DISABLE_RESERVED_FIELD - INVALID_OPTION_DISABLE_IN_USE_FIELD
  
  com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
  
  com.collabnet.ce.soap60.fault.DependencyViolationFault - if changing a status violates document dependency
  
  RemoteException
  
  See Also:
  
  FaultSummary
  
  deleteField
  
  public void deleteField(String sessionId, String fieldId) throws RemoteException
  
  Description copied from interface: IDocumentAppSoap
  
  Deletes a custom/flex-field.
  
  Specified by:
  
  deleteField in interface IDocumentAppSoap
  
  Parameters:
  
  sessionId - User session id.
  
  fieldId - the id of the field to delete
  
  Throws:
  
  com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid
  
  com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
  
  com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
  
  com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed.
  
  com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
  
  RemoteException
  
  addSeparator
  
  public void addSeparator(String sessionId, String projectId, String separatorType, String separatorLabel) throws RemoteException
  
  Description copied from interface: IDocumentAppSoap
  
  Adds a separator to a document root folder. The separator will be added at the end of document fields. To reorder separator and fields, use getOrderedDocumentFields and reorderDocumentFields.
  
  Specified by:
  
  addSeparator in interface IDocumentAppSoap
  
  Parameters:
  
  sessionId - User session id.
  
  projectId - The project in which to add the separator to.
  
  separatorType - the type of the separator, either OrderedDocumentFolderFieldSoapRow.ROW_SEPARATOR, OrderedDocumentFolderFieldSoapRow.COLUMN_SEPARATOR or OrderedDocumentFolderFieldSoapRow.SECTION_SEPARATOR.
  
  separatorLabel - the label of the separator
  
  Throws:
  
  com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid
  
  com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
  
  com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
  
  com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified
  
  com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
  
  com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - if a separator with the same id exists
  
  RemoteException
  
  deleteSeparator
  
  public void deleteSeparator(String sessionId, String layoutId) throws RemoteException
  
  Description copied from interface: IDocumentAppSoap
  
  Deletes a separator of a document root folder layout.
  
  Specified by:
  
  deleteSeparator in interface IDocumentAppSoap
  
  Parameters:
  
  sessionId - User session id.
  
  layoutId - the layout id of the separator. To get the layout id, use getOrderedDocumentFolderFields().
  
  Throws:
  
  com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid
  
  com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
  
  com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
  
  com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified
  
  com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed
  
  com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
  
  RemoteException
  
  getOrderedDocumentFields
  
  public OrderedDocumentFolderFieldSoapList getOrderedDocumentFields(String sessionId, String projectId) throws RemoteException
  
  Description copied from interface: IDocumentAppSoap
  
  Returns all the custom/flex-fields and the separators associated with the given project's document root folder with layout information.
  
  Specified by:
  
  getOrderedDocumentFields in interface IDocumentAppSoap
  
  Parameters:
  
  sessionId - User session id.
  
  projectId - The project for which to return the document fields information.
  
  Returns:
  
  Array of all fields and separators.
  
  Throws:
  
  com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
  
  com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
  
  com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
  
  com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
  
  RemoteException
  
  reorderDocumentFields
  
  public void reorderDocumentFields(String sessionId, String projectId, String[] layoutIds) throws RemoteException
  
  Description copied from interface: IDocumentAppSoap
  
  Sets a new order of the fields and the separators within the given project's document root folder. The fields and separators will be listed in this new order in UI and in the methods that list the fields and separators in the SOAP calls.
  
  Specified by:
  
  reorderDocumentFields in interface IDocumentAppSoap
  
  Parameters:
  
  sessionId - User session id.
  
  projectId - The project in which all the document fields and the separators belong to.
  
  layoutIds - An array of layout ids which can be obtained by getOrderedDocumentFields(). Layout id is different from field id and some system fields and separators do not have field id but only layout id.
  
  Throws:
  
  com.collabnet.ce.soap60.fault.InvalidSessionFault - When the specified session id is invalid.
  
  com.collabnet.ce.soap60.fault.NoSuchObjectFault - When any of the specified object id is invalid.
  
  com.collabnet.ce.soap60.fault.IllegalArgumentFault - If invalid argument value is passed.
  
  com.collabnet.ce.soap60.fault.PermissionDeniedFault - When the user has insufficient privileges.
  
  com.collabnet.ce.soap60.fault.SystemFault - When an unexpected system level error occurs.
  
  RemoteException

Class DocumentAppSoapStub

Field Summary

Fields inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub

Constructor Summary

Method Summary

Methods inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub

Methods inherited from class java.lang.Object

Constructor Detail

DocumentAppSoapStub

Method Detail

getDocumentFolderList

setDocumentFolderData

getDocumentFolderData

getAssignedDocumentReviewList

getDocumentReviewList

createReview

getDocumentList

getDocumentList2

getDocumentList3

findDocuments

findDocuments2

findDocuments3

createDocumentFolder

moveDocumentFolder

deleteDocumentFolder

createDocument

createDocument2

createDocument3

createDocumentWithUrl

createDocumentWithUrl2

createDocumentWithUrl3

moveDocument

moveDocument2

moveDocument3

deleteDocument

getDocumentData

getDocumentData2

getDocumentData3

setDocumentData

setDocumentData2

setDocumentData3

setDocumentDataWithAssociation

setDocumentDataWithAssociation2

setDocumentDataWithAssociation3

getDocumentFileId

getDocumentVersions

deleteDocumentByVersions

addTextField

addSingleSelectChildField

addSingleSelectField

addMultiSelectField

addUserSelectField

addDateField

getFields

setField

deleteField

addSeparator

deleteSeparator

getOrderedDocumentFields

reorderDocumentFields