Class Document3SoapDO
java.lang.Object
com.collabnet.ce.soap60.webservices.cemain.ObjectSoapDO
com.collabnet.ce.soap60.webservices.cemain.ItemSoapDO
com.collabnet.ce.soap60.webservices.docman.Document3SoapDO
This class represents the data associated with a document.
Change History
Release: 17.1
- Added flexFields.
- Changed the 'status' field of the document version to be configurable.
Release: 4.4
- Added 'fileUrl'
Release: 8.1
- Added downloadRestricted flag
- Added allowForceUnlock flag
- Since:
- 17.1
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns 'allowForceUnlock'.int
Returns 'currentVersion'.Returns 'dateVersionCreated'.Returns 'description'.int
Returns 'documentVersion'.boolean
Returns 'downloadRestricted'.Returns 'fileName'.long
Returns 'fileSize'.Returns 'fileUrl'.Returns 'flexFields'.int
Returns 'latestVersion'.Returns 'locale'.Returns 'lockedBy'.Returns 'mimeType'.Returns 'status'.Returns 'versionComment'.Returns 'versionCreatedBy'.static void
registerTypeMappings
(org.apache.axis.client.Call call) void
setAllowForceUnlock
(boolean allowForceUnlock) Sets 'allowForceUnlock'.void
setCurrentVersion
(int currentVersion) Sets 'currentVersion'.void
setDateVersionCreated
(Date dateVersionCreated) Sets 'dateVersionCreated'.void
setDescription
(String description) Sets 'description'.void
setDocumentVersion
(int documentVersion) Sets 'documentVersion'.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
setFlexFields
(SoapFieldValues flexFields) Sets 'flexFields'.void
setLatestVersion
(int latestVersion) Sets 'latestVersion'.void
Sets 'locale'.void
setLockedBy
(String lockedBy) Sets 'lockedBy'.void
setMimeType
(String mimeType) Sets 'mimeType'.void
Sets 'status'.void
setVersionComment
(String versionComment) Sets 'versionComment'.void
setVersionCreatedBy
(String versionCreatedBy) Sets 'versionCreatedBy'.Methods inherited from class com.collabnet.ce.soap60.webservices.cemain.ItemSoapDO
getFolderId, getPath, getTitle, setFolderId, setPath, setTitle
Methods inherited from class com.collabnet.ce.soap60.webservices.cemain.ObjectSoapDO
getCreatedBy, getCreatedDate, getId, getLastModifiedBy, getLastModifiedDate, getVersion, setCreatedBy, setCreatedDate, setId, setLastModifiedBy, setLastModifiedDate, setVersion
-
Field Details
-
MIME_TYPE_EXTERNAL_URL
The mime_type value for documents with an external file url.- See Also:
-
FILTER_REVIEW_STATUS
Document review 'status' filter.- See Also:
-
FILTER_REVIEW_CREATED_BY
Document review 'createdBy' filter.- See Also:
-
-
Constructor Details
-
Document3SoapDO
public Document3SoapDO()
-
-
Method Details
-
getDescription
Returns 'description'. Document description.- Returns:
- Value of 'description'.
-
setDescription
Sets 'description'. Document description.- Parameters:
description
- Value of 'description'.
-
getDocumentVersion
public int getDocumentVersion()Returns 'documentVersion'. Version associated with this document instance data.- Returns:
- Value of 'documentVersion'.
-
setDocumentVersion
public void setDocumentVersion(int documentVersion) Sets 'documentVersion'. Version associated with this document instance data.- Parameters:
documentVersion
- Value of 'documentVersion'.
-
getVersionComment
Returns 'versionComment'. Comment associated with this document version.- Returns:
- Value of 'versionComment'.
-
setVersionComment
Sets 'versionComment'. Comment associated with this document version.- Parameters:
versionComment
- Value of 'versionComment'.
-
getCurrentVersion
public int getCurrentVersion()Returns 'currentVersion'. Version number of the currently active version.- Returns:
- Value of 'currentVersion'.
-
setCurrentVersion
public void setCurrentVersion(int currentVersion) Sets 'currentVersion'. Version number of the currently active version.- Parameters:
currentVersion
- Value of 'currentVersion'.
-
getLatestVersion
public int getLatestVersion()Returns 'latestVersion'. Version number of the latest document version.- Returns:
- Value of 'latestVersion'.
-
setLatestVersion
public void setLatestVersion(int latestVersion) Sets 'latestVersion'. Version number of the latest document version.- Parameters:
latestVersion
- Value of 'latestVersion'.
-
getDateVersionCreated
Returns 'dateVersionCreated'. Date this version was created.- Returns:
- Value of 'dateVersionCreated'.
-
setDateVersionCreated
Sets 'dateVersionCreated'. Date this version was created.- Parameters:
dateVersionCreated
- Value of 'dateVersionCreated'.
-
getVersionCreatedBy
Returns 'versionCreatedBy'. User who created this version.- Returns:
- Value of 'versionCreatedBy'.
-
setVersionCreatedBy
Sets 'versionCreatedBy'. User who created this version.- Parameters:
versionCreatedBy
- Value of 'versionCreatedBy'.
-
getLocale
Returns 'locale'. Document's locale (common across all versions).- Returns:
- Value of 'locale'.
-
setLocale
Sets 'locale'. Document's locale (common across all versions).- Parameters:
locale
- Value of 'locale'.
-
getMimeType
Returns 'mimeType'. Mime-type of this version of the document. (null when this is a document to an external url) {- Returns:
- Value of 'mimeType'.
-
setMimeType
Sets 'mimeType'. Mime-type of this version of the document. (null when this is a document to an external url) {- Parameters:
mimeType
- Value of 'mimeType'.
-
getFileName
Returns 'fileName'. Name of the file associated with this document version.- Returns:
- Value of 'fileName'.
-
setFileName
Sets 'fileName'. Name of the file associated with this document version.- Parameters:
fileName
- Value of 'fileName'.
-
getFileSize
public long getFileSize()Returns 'fileSize'. Size of the file associated with this document version.- Returns:
- Value of 'fileSize'.
-
setFileSize
public void setFileSize(long fileSize) Sets 'fileSize'. Size of the file associated with this document version.- Parameters:
fileSize
- Value of 'fileSize'.
-
getFileUrl
Returns 'fileUrl'. Url of the file associated with this document version.- Returns:
- Value of 'fileUrl'.
-
setFileUrl
Sets 'fileUrl'. Url of the file associated with this document version.- Parameters:
fileUrl
- Value of 'fileUrl'.
-
getStatus
Returns 'status'. Status of this document version. Can be one of the custom (user specified) { value, as defined in the project's document settings.- Returns:
- Value of 'status'.
-
setStatus
Sets 'status'. Status of this document version. Can be one of the custom (user specified) { value, as defined in the project's document settings.- Parameters:
status
- Value of 'status'.
-
getLockedBy
Returns 'lockedBy'. User with a lock on this document, if any. Null if document is not locked.- Returns:
- Value of 'lockedBy'.
-
setLockedBy
Sets 'lockedBy'. 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'.
-
getFlexFields
Returns 'flexFields'. Named values for custom fields for the document folder that contains the document. For multi-select custom fields, the name is repeated for each value. For example, for a multi-select field days_of_week where MWF are set, SoapFieldValues { names = {"days_of_week", "days_of_week", "days_of_week"}, values = {"Monday", "Wednesday", "Friday"} types = {DocumentFolderFieldSoapDO.FIELD_VALUE_TYPE_STRING, DocumentFolderFieldSoapDO.FIELD_VALUE_TYPE_STRING, DocumentFolderFieldSoapDO.FIELD_VALUE_TYPE_STRING} }- Returns:
- Value of 'flexFields'.
-
setFlexFields
Sets 'flexFields'. Named values for custom fields for the document folder that contains the document. For multi-select custom fields, the name is repeated for each value. For example, for a multi-select field days_of_week where MWF are set, SoapFieldValues { names = {"days_of_week", "days_of_week", "days_of_week"}, values = {"Monday", "Wednesday", "Friday"} types = {DocumentFolderFieldSoapDO.FIELD_VALUE_TYPE_STRING, DocumentFolderFieldSoapDO.FIELD_VALUE_TYPE_STRING, DocumentFolderFieldSoapDO.FIELD_VALUE_TYPE_STRING} }- Parameters:
flexFields
- Value of 'flexFields'.
-
registerTypeMappings
public static void registerTypeMappings(org.apache.axis.client.Call call)
-