public interface IDocumentAppSoap
Modifier and Type | Method and Description |
---|---|
DocumentSoapDO |
createDocument(String sessionId,
String parentId,
String title,
String description,
String versionComment,
String status,
boolean createLocked,
String fileName,
String mimeType,
String fileId,
String associationId,
String associationDesc)
Deprecated.
in favor of createDocument2
|
Document2SoapDO |
createDocument2(String sessionId,
String parentId,
String title,
String description,
String versionComment,
String status,
boolean createLocked,
boolean createDownloadRestricted,
boolean allowForceUnlock,
String fileName,
String mimeType,
String fileId,
String associationId,
String associationDesc)
Creates a new document with the specified title, description, etc.
|
DocumentFolderSoapDO |
createDocumentFolder(String sessionId,
String parentId,
String title,
String description)
Creates a new document folder with the specified title, description, etc.
|
DocumentSoapDO |
createDocumentWithUrl(String sessionId,
String parentId,
String title,
String description,
String versionComment,
String status,
boolean createLocked,
String fileUrl,
String associationId,
String associationDesc)
Deprecated.
in favor of createDocumentWithUrl2
|
Document2SoapDO |
createDocumentWithUrl2(String sessionId,
String parentId,
String title,
String description,
String versionComment,
String status,
boolean createLocked,
boolean createDownloadRestricted,
boolean allowForceUnlock,
String fileUrl,
String associationId,
String associationDesc)
Creates a new document with the specified title, description, etc. for a URL with an association.
|
DocumentReviewSoapDO |
createReview(String sessionId,
String documentId,
int version,
String title,
String description,
Date dueDate,
String[] requiredReviewers,
String[] optionalReviewers,
boolean attachDocument)
Creates a document review cycle
|
void |
deleteDocument(String sessionId,
String documentId)
Deletes a document.Locked document(s) cannot be deleted, When a locked document's id is passed to this API, a SystemFault will be thrown.
|
void |
deleteDocumentByVersions(String sessionId,
String documentId,
int[] versionNumbers)
Deletes particular version(s) of a document.Locked document version(s) cannot be deleted, When a locked document's id is passed to this API, a SystemFault will be thrown.
|
void |
deleteDocumentFolder(String sessionId,
String folderId)
Deletes a document folder with the specified id.
|
DocumentSoapList |
findDocuments(String sessionId,
String queryString,
String projectId,
boolean searchAttachments,
boolean currentVersionsOnly)
Deprecated.
in favor of findDocuments2
|
Document2SoapList |
findDocuments2(String sessionId,
String queryString,
String projectId,
boolean searchAttachments,
boolean currentVersionsOnly)
Finds a list of documents matching a search string.
|
DocumentReviewSoapList |
getAssignedDocumentReviewList(String sessionId,
String username)
Lists all document reviews assigned to a user for review.
|
DocumentSoapDO |
getDocumentData(String sessionId,
String documentId,
int documentVersion)
Deprecated.
in favor of getDocumentData2
|
Document2SoapDO |
getDocumentData2(String sessionId,
String documentId,
int documentVersion)
Gets specified document data.
|
String |
getDocumentFileId(String sessionId,
String documentId,
int documentVersion)
Returns a the file id associated with the document file.
|
DocumentFolderSoapDO |
getDocumentFolderData(String sessionId,
String folderId)
Gets detailed data on a document folder
|
DocumentFolderSoapList |
getDocumentFolderList(String sessionId,
String parentId,
boolean recursive)
Lists document folders.
|
DocumentSoapList |
getDocumentList(String sessionId,
String parentId,
com.collabnet.ce.soap60.types.SoapFilter[] filters)
Deprecated.
in favor of getDocumentList2
|
Document2SoapList |
getDocumentList2(String sessionId,
String parentId,
com.collabnet.ce.soap60.types.SoapFilter[] filters)
Lists all documents within a document folder.
|
DocumentReviewSoapList |
getDocumentReviewList(String sessionId,
String containerId,
com.collabnet.ce.soap60.types.SoapFilter[] filters)
Lists all document reviews within a project or a document.
|
Document2SoapList |
getDocumentVersions(String sessionId,
String documentId,
boolean includeDeletedVersions)
Lists all the versions of a document.
|
DocumentSoapDO |
moveDocument(String sessionId,
String documentId,
String targetFolderId)
Deprecated.
in favor of moveDocument2
|
Document2SoapDO |
moveDocument2(String sessionId,
String documentId,
String targetFolderId)
Moves a document to a specified target folder.
|
DocumentFolderSoapDO |
moveDocumentFolder(String sessionId,
String folderId,
String destFolderId)
Moves document folder
|
void |
setDocumentData(String sessionId,
DocumentSoapDO documentData,
String fileId)
Deprecated.
in favor of setDocumentData2
|
void |
setDocumentData2(String sessionId,
Document2SoapDO documentData,
String fileId)
Sets specified document data.
|
void |
setDocumentDataWithAssociation(String sessionId,
DocumentSoapDO documentData,
String fileId,
String associationId,
String associationComment)
Deprecated.
in favor of setDocumentDataWithAssociation2
|
void |
setDocumentDataWithAssociation2(String sessionId,
Document2SoapDO documentData,
String fileId,
String associationId,
String associationComment)
Sets specified document data with association.
|
void |
setDocumentFolderData(String sessionId,
DocumentFolderSoapDO documentFolderData)
Sets detailed data on a document folder
|
DocumentFolderSoapList getDocumentFolderList(String sessionId, String parentId, boolean recursive) throws RemoteException
sessionId
- SOAP session id.parentId
- Parent document folder id -or- project id for listing root document folder.recursive
- Show subfolders of the folders returnedcom.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
void setDocumentFolderData(String sessionId, DocumentFolderSoapDO documentFolderData) throws RemoteException
sessionId
- SOAP session id.documentFolderData
- Data to apply.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
DocumentFolderSoapDO getDocumentFolderData(String sessionId, String folderId) throws RemoteException
sessionId
- SOAP session id.folderId
- Folder id to get detailed data for.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
DocumentReviewSoapList getAssignedDocumentReviewList(String sessionId, String username) throws RemoteException
sessionId
- SOAP session id.username
- User to whom reviews are assigned for review (required or optional).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
DocumentReviewSoapList getDocumentReviewList(String sessionId, String containerId, com.collabnet.ce.soap60.types.SoapFilter[] filters) throws RemoteException
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.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
DocumentReviewSoapDO createReview(String sessionId, String documentId, int version, String title, String description, Date dueDate, String[] requiredReviewers, String[] optionalReviewers, boolean attachDocument) throws RemoteException
sessionId
- SOAP session id.documentId
- the id of the document for which the review is to be created.version
- the version of the documenttitle
- The title of the reviewdescription
- The description of the reviewdueDate
- The due date of the reviewrequiredReviewers
- an array of usernames of required reviewersoptionalReviewers
- an array of usernames of optional reviewersattachDocument
- whether to attach the document to the email or notcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when sessionId is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when there is no document corresponding to the document Idcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privilegescom.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 documentcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
DocumentSoapList getDocumentList(String sessionId, String parentId, com.collabnet.ce.soap60.types.SoapFilter[] filters) throws RemoteException
filters
for future use. Must be null or empty for now.sessionId
- SOAP session id.parentId
- Document folder id (obtained from getDocumentFolderList).filters
- not supported.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
Document2SoapList getDocumentList2(String sessionId, String parentId, com.collabnet.ce.soap60.types.SoapFilter[] filters) throws RemoteException
filters
for future use. Must be null or empty for now.sessionId
- SOAP session id.parentId
- Document folder id (obtained from getDocumentFolderList).filters
- not supported.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
DocumentSoapList findDocuments(String sessionId, String queryString, String projectId, boolean searchAttachments, boolean currentVersionsOnly) throws RemoteException
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.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
Document2SoapList findDocuments2(String sessionId, String queryString, String projectId, boolean searchAttachments, boolean currentVersionsOnly) throws RemoteException
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.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
DocumentFolderSoapDO createDocumentFolder(String sessionId, String parentId, String title, String description) throws RemoteException
sessionId
- SOAP session id.parentId
- Folder id in which to create this folder.title
- Document folder title.description
- Document folder description.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
DocumentFolderSoapDO moveDocumentFolder(String sessionId, String folderId, String destFolderId) throws RemoteException
sessionId
- SOAP session id.folderId
- ID of folder to move.destFolderId
- ID of destination foldercom.collabnet.ce.soap60.fault.InvalidSessionFault
- sessionId is invalidcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- permission is denied for the specified operationcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- specified object is invalidcom.collabnet.ce.soap60.fault.SystemFault
- unexpected system errorRemoteException
void deleteDocumentFolder(String sessionId, String folderId) throws RemoteException
sessionId
- SOAP session id.folderId
- Folder id to delete.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 invalidcom.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
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
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 associatedcom.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
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
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 associatedcom.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
DocumentSoapDO createDocumentWithUrl(String sessionId, String parentId, String title, String description, String versionComment, String status, boolean createLocked, String fileUrl, String associationId, String associationDesc) throws RemoteException
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 documentassociationId
- 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 commentcom.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 failedcom.collabnet.ce.soap60.fault.InvalidAssociationFault
- when an invalid association object is passed.RemoteException
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
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 documentassociationId
- 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 commentcom.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 failedcom.collabnet.ce.soap60.fault.InvalidAssociationFault
- when an invalid association object is passed.RemoteException
DocumentSoapDO moveDocument(String sessionId, String documentId, String targetFolderId) throws RemoteException
sessionId
- User session id.documentId
- ID of document to move.targetFolderId
- Target folder ID.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
Document2SoapDO moveDocument2(String sessionId, String documentId, String targetFolderId) throws RemoteException
sessionId
- User session id.documentId
- ID of document to move.targetFolderId
- Target folder ID.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
void deleteDocument(String sessionId, String documentId) throws RemoteException
sessionId
- User session id.documentId
- Document id.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
DocumentSoapDO getDocumentData(String sessionId, String documentId, int documentVersion) throws RemoteException
sessionId
- User session id.documentId
- Document id.documentVersion
- Document version number (specify zero for current version).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
Document2SoapDO getDocumentData2(String sessionId, String documentId, int documentVersion) throws RemoteException
sessionId
- User session id.documentId
- Document id.documentVersion
- Document version number (specify zero for current version).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
void setDocumentData(String sessionId, DocumentSoapDO documentData, String fileId) throws RemoteException
sessionId
- User session id.documentData
- Document data object.fileId
- Uploaded file id (through FileStorageApp or SimpleFileStorageApp service).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 failedRemoteException
void setDocumentData2(String sessionId, Document2SoapDO documentData, String fileId) throws RemoteException
sessionId
- User session id.documentData
- Document data object.fileId
- Uploaded file id (through FileStorageApp or SimpleFileStorageApp service).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 failedRemoteException
void setDocumentDataWithAssociation(String sessionId, DocumentSoapDO documentData, String fileId, String associationId, String associationComment) throws RemoteException
sessionId
- User session id.documentData
- Document data object.fileId
- Uploaded file id (through FileStorageApp or SimpleFileStorageApp service).associationId
- The id of the associationassociationComment
- Comment for the associationcom.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 failedcom.collabnet.ce.soap60.fault.InvalidAssociationFault
- when an invalid association object is passed.RemoteException
void setDocumentDataWithAssociation2(String sessionId, Document2SoapDO documentData, String fileId, String associationId, String associationComment) throws RemoteException
sessionId
- User session id.documentData
- Document data object.fileId
- Uploaded file id (through FileStorageApp or SimpleFileStorageApp service).associationId
- The id of the associationassociationComment
- Comment for the associationcom.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 failedcom.collabnet.ce.soap60.fault.InvalidAssociationFault
- when an invalid association object is passed.RemoteException
String getDocumentFileId(String sessionId, String documentId, int documentVersion) throws RemoteException
sessionId
- User session id.documentId
- document id.documentVersion
- document version number (specify zero for current version).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
Document2SoapList getDocumentVersions(String sessionId, String documentId, boolean includeDeletedVersions) throws RemoteException
sessionId
- SOAP session id.documentId
- Document id.includeDeletedVersions
- Flag to indicate if the deleted versions of the document are to be fetched.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
void deleteDocumentByVersions(String sessionId, String documentId, int[] versionNumbers) throws RemoteException
Note: Deleted document version(s) cannot be recovered, as they will be permanently deleted from the system.
sessionId
- User session id.documentId
- Document id.versionNumbers
- Versions of the document to be deletedcom.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
Copyright © 2016 CollabNet. All Rights Reserved.