Class DocumentSoapDO
java.lang.Object
com.collabnet.ce.soap60.webservices.cemain.ObjectSoapDO
com.collabnet.ce.soap60.webservices.cemain.ItemSoapDO
com.collabnet.ce.soap60.webservices.docman.DocumentSoapDO
This class represents the data associated with a document.
Change History
Release: 4.4
- Added 'fileUrl'
- Since:
- 4.1
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Possible value for the 'status' field.static final String
Document review 'createdBy' filter.static final String
Document review 'status' filter.static final String
Possible value for the 'status' field.static final String
The mime_type value for documents with an external file url.static final String
Possible value for the 'status' field. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
Returns 'currentVersion'.Returns 'dateVersionCreated'.Returns 'description'.int
Returns 'documentVersion'.Returns 'fileName'.long
Returns 'fileSize'.Returns 'fileUrl'.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
setCurrentVersion
(int currentVersion) Sets 'currentVersion'.void
setDateVersionCreated
(Date dateVersionCreated) Sets 'dateVersionCreated'.void
setDescription
(String description) Sets 'description'.void
setDocumentVersion
(int documentVersion) Sets 'documentVersion'.void
setFileName
(String fileName) Sets 'fileName'.void
setFileSize
(long fileSize) Sets 'fileSize'.void
setFileUrl
(String fileUrl) Sets 'fileUrl'.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
-
DRAFT
Possible value for the 'status' field.- See Also:
-
FINAL
Possible value for the 'status' field.- See Also:
-
REVIEW
Possible value for the 'status' field.- See Also:
-
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
-
DocumentSoapDO
public DocumentSoapDO()
-
-
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. Possible values are the constants DRAFT or FINAL.- Returns:
- Value of 'status'.
-
setStatus
Sets 'status'. Status of this document version. Possible values are the constants DRAFT or FINAL.- 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'.
-
registerTypeMappings
public static void registerTypeMappings(org.apache.axis.client.Call call)
-