Class Document2SoapRow
java.lang.Object
com.collabnet.ce.soap60.webservices.docman.Document2SoapRow
DocumentList class represents the list of documents.
Change History
Release: 4.2
- Field 'fileSize' type changed from 'Long' to 'long'.
Release: 4.4
- Added 'fileUrl'
Release: 8.1
- Added downloadRestricted flag
- Added allowForceUnlock flag
- Since:
- 4.1
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns 'allowForceUnlock'.Returns 'createdBy'.int
Returns 'currentVersion'.Returns 'dateCreated'.Returns 'dateLastModified'.Returns 'dateVersionCreated'.Returns 'description'.boolean
Returns 'downloadRestricted'.Returns 'fileName'.long
Returns 'fileSize'.Returns 'fileUrl'.Returns 'folderId'.Returns 'folderPathString'.Returns 'folderTitle'.getId()
Returns 'id'.Returns 'lastModifiedBy'.Returns 'lastModifiedByFullName'.Returns 'lockedBy'.Returns 'mimeType'.Returns 'projectId'.Returns 'projectPathString'.Returns 'projectTitle'.getTitle()
Returns 'title'.Returns 'versionComment'.Returns 'versionCreatedBy'.Returns 'versionCreatedByFullname'.Returns 'versionId'.int
Returns 'versionNumber'.Returns 'versionStatus'.static void
registerTypeMappings
(org.apache.axis.client.Call call) void
setAllowForceUnlock
(boolean allowForceUnlock) Sets 'allowForceUnlock'.void
setCreatedBy
(String createdBy) Sets 'createdBy'.void
setCurrentVersion
(int currentVersion) Sets 'currentVersion'.void
setDateCreated
(Date dateCreated) Sets 'dateCreated'.void
setDateLastModified
(Date dateLastModified) Sets 'dateLastModified'.void
setDateVersionCreated
(Date dateVersionCreated) Sets 'dateVersionCreated'.void
setDescription
(String description) Sets 'description'.void
setDownloadRestricted
(boolean downloadRestricted) Sets 'downloadRestricted'.void
setFileName
(String fileName) Sets 'fileName'.void
setFileSize
(long fileSize) Sets 'fileSize'.void
setFileUrl
(String fileUrl) Sets 'fileUrl'.void
setFolderId
(String folderId) Sets 'folderId'.void
setFolderPathString
(String folderPathString) Sets 'folderPathString'.void
setFolderTitle
(String folderTitle) Sets 'folderTitle'.void
Sets 'id'.void
setLastModifiedBy
(String lastModifiedBy) Sets 'lastModifiedBy'.void
setLastModifiedByFullName
(String lastModifiedByFullName) Sets 'lastModifiedByFullName'.void
setLockedBy
(String lockedBy) Sets 'lockedBy'.void
setMimeType
(String mimeType) Sets 'mimeType'.void
setProjectId
(String projectId) Sets 'projectId'.void
setProjectPathString
(String projectPathString) Sets 'projectPathString'.void
setProjectTitle
(String projectTitle) Sets 'projectTitle'.void
Sets 'title'.void
setVersionComment
(String versionComment) Sets 'versionComment'.void
setVersionCreatedBy
(String versionCreatedBy) Sets 'versionCreatedBy'.void
setVersionCreatedByFullname
(String versionCreatedByFullname) Sets 'versionCreatedByFullname'.void
setVersionId
(String versionId) Sets 'versionId'.void
setVersionNumber
(int versionNumber) Sets 'versionNumber'.void
setVersionStatus
(String versionStatus) Sets 'versionStatus'.
-
Field Details
-
VERSION_STATUS_DRAFT
- See Also:
-
VERSION_STATUS_REVIEW
- See Also:
-
VERSION_STATUS_FINAL
- See Also:
-
-
Constructor Details
-
Document2SoapRow
public Document2SoapRow()
-
-
Method Details
-
getId
Returns 'id'.- Returns:
- Value of 'id'.
-
setId
Sets 'id'.- Parameters:
id
- Value of 'id'.
-
getVersionId
Returns 'versionId'. The id of the specified version of the document- Returns:
- Value of 'versionId'.
-
setVersionId
Sets 'versionId'. The id of the specified version of the document- Parameters:
versionId
- Value of 'versionId'.
-
getVersionNumber
public int getVersionNumber()Returns 'versionNumber'. The version number of the document- Returns:
- Value of 'versionNumber'.
-
setVersionNumber
public void setVersionNumber(int versionNumber) Sets 'versionNumber'. The version number of the document- Parameters:
versionNumber
- Value of 'versionNumber'.
-
getProjectPathString
Returns 'projectPathString'. The path of the project containing the document- Returns:
- Value of 'projectPathString'.
-
setProjectPathString
Sets 'projectPathString'. The path of the project containing the document- Parameters:
projectPathString
- Value of 'projectPathString'.
-
getProjectTitle
Returns 'projectTitle'. The title of the project containing the document- Returns:
- Value of 'projectTitle'.
-
setProjectTitle
Sets 'projectTitle'. The title of the project containing the document- Parameters:
projectTitle
- Value of 'projectTitle'.
-
getProjectId
Returns 'projectId'. The id of the project containing the document- Returns:
- Value of 'projectId'.
-
setProjectId
Sets 'projectId'. The id of the project containing the document- Parameters:
projectId
- Value of 'projectId'.
-
getFolderTitle
Returns 'folderTitle'. The title of the document folder containing the document- Returns:
- Value of 'folderTitle'.
-
setFolderTitle
Sets 'folderTitle'. The title of the document folder containing the document- Parameters:
folderTitle
- Value of 'folderTitle'.
-
getFolderId
Returns 'folderId'. The id of the document folder containing the document- Returns:
- Value of 'folderId'.
-
setFolderId
Sets 'folderId'. The id of the document folder containing the document- Parameters:
folderId
- Value of 'folderId'.
-
getFolderPathString
Returns 'folderPathString'.- Returns:
- Value of 'folderPathString'.
-
setFolderPathString
Sets 'folderPathString'.- Parameters:
folderPathString
- Value of 'folderPathString'.
-
getTitle
Returns 'title'. The title of the document- Returns:
- Value of 'title'.
-
setTitle
Sets 'title'. The title of the document- Parameters:
title
- Value of 'title'.
-
getDescription
Returns 'description'. The description of the document- Returns:
- Value of 'description'.
-
setDescription
Sets 'description'. The description of the document- Parameters:
description
- Value of 'description'.
-
getCreatedBy
Returns 'createdBy'. The username of the user who created the document- Returns:
- Value of 'createdBy'.
-
setCreatedBy
Sets 'createdBy'. The username of the user who created the document- Parameters:
createdBy
- Value of 'createdBy'.
-
getDateCreated
Returns 'dateCreated'. The date the document was created- Returns:
- Value of 'dateCreated'.
-
setDateCreated
Sets 'dateCreated'. The date the document was created- Parameters:
dateCreated
- Value of 'dateCreated'.
-
getLastModifiedBy
Returns 'lastModifiedBy'. The username of the user who last modified the document details- Returns:
- Value of 'lastModifiedBy'.
-
setLastModifiedBy
Sets 'lastModifiedBy'. The username of the user who last modified the document details- Parameters:
lastModifiedBy
- Value of 'lastModifiedBy'.
-
getLastModifiedByFullName
Returns 'lastModifiedByFullName'. The full name of the user who last modified the document details- Returns:
- Value of 'lastModifiedByFullName'.
-
setLastModifiedByFullName
Sets 'lastModifiedByFullName'. The full name of the user who last modified the document details- Parameters:
lastModifiedByFullName
- Value of 'lastModifiedByFullName'.
-
getDateLastModified
Returns 'dateLastModified'. The date the document details were last modified- Returns:
- Value of 'dateLastModified'.
-
setDateLastModified
Sets 'dateLastModified'. The date the document details were last modified- Parameters:
dateLastModified
- Value of 'dateLastModified'.
-
getCurrentVersion
public int getCurrentVersion()Returns 'currentVersion'. The number of the current version of the document- Returns:
- Value of 'currentVersion'.
-
setCurrentVersion
public void setCurrentVersion(int currentVersion) Sets 'currentVersion'. The number of the current version of the document- Parameters:
currentVersion
- Value of 'currentVersion'.
-
getDateVersionCreated
Returns 'dateVersionCreated'. The date the specified version was created- Returns:
- Value of 'dateVersionCreated'.
-
setDateVersionCreated
Sets 'dateVersionCreated'. The date the specified version was created- Parameters:
dateVersionCreated
- Value of 'dateVersionCreated'.
-
getVersionCreatedBy
Returns 'versionCreatedBy'. The user name of the user who created this version of the file- Returns:
- Value of 'versionCreatedBy'.
-
setVersionCreatedBy
Sets 'versionCreatedBy'. The user name of the user who created this version of the file- Parameters:
versionCreatedBy
- Value of 'versionCreatedBy'.
-
getVersionStatus
Returns 'versionStatus'. The status of this version of the document. Can be one of VERSION_STATUS_DRAFT, VERSION_STATUS_REVIEW or VERSION_STATUS_FINAL- Returns:
- Value of 'versionStatus'.
-
setVersionStatus
Sets 'versionStatus'. The status of this version of the document. Can be one of VERSION_STATUS_DRAFT, VERSION_STATUS_REVIEW or VERSION_STATUS_FINAL- Parameters:
versionStatus
- Value of 'versionStatus'.
-
getVersionComment
Returns 'versionComment'. The comment provided by the user when creating this version of the file- Returns:
- Value of 'versionComment'.
-
setVersionComment
Sets 'versionComment'. The comment provided by the user when creating this version of the file- Parameters:
versionComment
- Value of 'versionComment'.
-
getVersionCreatedByFullname
Returns 'versionCreatedByFullname'. The full name of the user who created the file- Returns:
- Value of 'versionCreatedByFullname'.
-
setVersionCreatedByFullname
Sets 'versionCreatedByFullname'. The full name of the user who created the file- Parameters:
versionCreatedByFullname
- Value of 'versionCreatedByFullname'.
-
getMimeType
Returns 'mimeType'. The mime type of the file- Returns:
- Value of 'mimeType'.
-
setMimeType
Sets 'mimeType'. The mime type of the file- Parameters:
mimeType
- Value of 'mimeType'.
-
getFileName
Returns 'fileName'. The name of the file used for downloading- Returns:
- Value of 'fileName'.
-
setFileName
Sets 'fileName'. The name of the file used for downloading- Parameters:
fileName
- Value of 'fileName'.
-
getFileSize
public long getFileSize()Returns 'fileSize'. The size of the file, in bytes- Returns:
- Value of 'fileSize'.
-
setFileSize
public void setFileSize(long fileSize) Sets 'fileSize'. The size of the file, in bytes- Parameters:
fileSize
- Value of 'fileSize'.
-
getFileUrl
Returns 'fileUrl'. The url of the file stored- Returns:
- Value of 'fileUrl'.
-
setFileUrl
Sets 'fileUrl'. The url of the file stored- Parameters:
fileUrl
- Value of 'fileUrl'.
-
getLockedBy
Returns 'lockedBy'. Id of the user with a lock on this document, if any. Null if document is not locked.- Returns:
- Value of 'lockedBy'.
-
setLockedBy
Sets 'lockedBy'. Id of the user with a lock on this document, if any. Null if document is not locked.- Parameters:
lockedBy
- Value of 'lockedBy'.
-
getDownloadRestricted
public boolean getDownloadRestricted()Returns 'downloadRestricted'. Flag that indicates if the document is locked to prevent other users from downloading it.- Returns:
- Value of 'downloadRestricted'.
-
setDownloadRestricted
public void setDownloadRestricted(boolean downloadRestricted) Sets 'downloadRestricted'. Flag that indicates if the document is locked to prevent other users from downloading it.- Parameters:
downloadRestricted
- Value of 'downloadRestricted'.
-
getAllowForceUnlock
public boolean getAllowForceUnlock()Returns 'allowForceUnlock'. Flag that indicates if the document can be forcibly unlocked for editing and downloading.- Returns:
- Value of 'allowForceUnlock'.
-
setAllowForceUnlock
public void setAllowForceUnlock(boolean allowForceUnlock) Sets 'allowForceUnlock'. Flag that indicates if the document can be forcibly unlocked for editing and downloading.- Parameters:
allowForceUnlock
- Value of 'allowForceUnlock'.
-
registerTypeMappings
public static void registerTypeMappings(org.apache.axis.client.Call call)
-