Package com.collabnet.ce.soap60.webservices.docman

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
public class DocumentSoapDO extends ItemSoapDO
This class represents the data associated with a document.
Change History
Release: 4.4
  • Added 'fileUrl'
Since:
4.1

  • Field Details

  • Constructor Details

    • DocumentSoapDO

      public DocumentSoapDO()

  • Method Details

    • getDescription

      public String getDescription()
      Returns 'description'. Document description.
      Returns:
      Value of 'description'.

    • setDescription

      public void setDescription(String description)
      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

      public String getVersionComment()
      Returns 'versionComment'. Comment associated with this document version.
      Returns:
      Value of 'versionComment'.

    • setVersionComment

      public void setVersionComment(String versionComment)
      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

      public Date getDateVersionCreated()
      Returns 'dateVersionCreated'. Date this version was created.
      Returns:
      Value of 'dateVersionCreated'.

    • setDateVersionCreated

      public void setDateVersionCreated(Date dateVersionCreated)
      Sets 'dateVersionCreated'. Date this version was created.
      Parameters:
      dateVersionCreated - Value of 'dateVersionCreated'.

    • getVersionCreatedBy

      public String getVersionCreatedBy()
      Returns 'versionCreatedBy'. User who created this version.
      Returns:
      Value of 'versionCreatedBy'.

    • setVersionCreatedBy

      public void setVersionCreatedBy(String versionCreatedBy)
      Sets 'versionCreatedBy'. User who created this version.
      Parameters:
      versionCreatedBy - Value of 'versionCreatedBy'.

    • getLocale

      public String getLocale()
      Returns 'locale'. Document's locale (common across all versions).
      Returns:
      Value of 'locale'.

    • setLocale

      public void setLocale(String locale)
      Sets 'locale'. Document's locale (common across all versions).
      Parameters:
      locale - Value of 'locale'.

    • getMimeType

      public String 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

      public void setMimeType(String mimeType)
      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

      public String getFileName()
      Returns 'fileName'. Name of the file associated with this document version.
      Returns:
      Value of 'fileName'.

    • setFileName

      public void setFileName(String fileName)
      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

      public String getFileUrl()
      Returns 'fileUrl'. Url of the file associated with this document version.
      Returns:
      Value of 'fileUrl'.

    • setFileUrl

      public void setFileUrl(String fileUrl)
      Sets 'fileUrl'. Url of the file associated with this document version.
      Parameters:
      fileUrl - Value of 'fileUrl'.

    • getStatus

      public String getStatus()
      Returns 'status'. Status of this document version. Possible values are the constants DRAFT or FINAL.
      Returns:
      Value of 'status'.

    • setStatus

      public void setStatus(String status)
      Sets 'status'. Status of this document version. Possible values are the constants DRAFT or FINAL.
      Parameters:
      status - Value of 'status'.

    • getLockedBy

      public String getLockedBy()
      Returns 'lockedBy'. User with a lock on this document, if any. Null if document is not locked.
      Returns:
      Value of 'lockedBy'.

    • setLockedBy

      public void setLockedBy(String lockedBy)
      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)