Package de.elo.ix.client

Class DocVersion

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.DocVersion
All Implemented Interfaces:
Serializable
public class DocVersion extends ValueClass implements Serializable

Description: This class describes a document version, a document preview or a signature.

Copyright: Copyright (c) 2002

Organisation: ELO DIgital Office GmbH

See Also:

  • Field Details

    • accessDateIso

      protected String accessDateIso
      Last access date. ClientInfo determines the Timezone.

      Applies to document version and signature. Is undefined for preview and fulltextContent.

    • comment

      protected String comment
      Version comment

      Applies to document version. Is undefined for signature, preview and fulltextContent.

    • createDateIso

      protected String createDateIso
      Create date. ClientInfo determines the Timezone.

      Applies to document version and signature. Is undefined for preview and fulltextContent.

    • deleted

      protected boolean deleted
      Indicates whether the version is logically deleted.

      Applies to document version. Is undefined for signature, preview and fulltextContent.

    • ext

      protected String ext
      Document file extension (without ".")

      Applies to document version, signature and preview. Is readonly for fulltextContent.

      This value has precedence before contentType.
      See Also:

    • contentType

      protected String contentType
      Content-Type (MIME-Type).
      Since:
      6.00.095
      See Also:

    • fileData

      protected FileData fileData
      Document, preview or fulltextContent file content. If checkoutDoc is called with option mbSordDocSmallContent and the requested document (version) is small (less than the configured value), this member contains the file data and content type. If mbPreview is additionally set, fileData contains the content of the preview - REGARDLESS of the size. In case there is no preview, fileData contains the data of the document (if it's a small file).

      Applies to document version, signature and preview.

    • guid

      protected String guid
      Document GUID.

      Applies to document version and signature. Is undefined for preview and fulltextContent.

    • id

      protected int id
      Document ID

      Applies to document version and signature. Is undefined for preview and fulltextContent.

    • md5

      protected String md5
      MD5 hash of the documet file.

      Applies to document version and signature. Is undefined for preview and fulltextContent.

    • milestone

      protected boolean milestone
      Indicates whether the version is marked as a milestone version.

      Applies to document version. Is undefined for signature and preview and fulltextContent.

    • ownerId

      protected int ownerId
      The owners user ID.

      Applies to document version. Is undefined for signature and preview and fulltextContent.

    • ownerName

      protected String ownerName
      The owners user name. This value is read only (ignored in checkinDoc...).

      Applies to document version. Is undefined for signature and preview and fulltextContent.

    • pathId

      protected int pathId
      Storage path ID

      Applies to document version and signature. Is undefined for preview and fulltextContent.

    • pathId2

      protected int pathId2
      (to be defined)

      Applies to document version and signature. Is undefined for preview and fulltextContent.

    • physPath

      protected String physPath
      Physical path

      Applies to document version and signature. Is undefined for preview and fulltextContent.

      Set SordC.mbPhysPath or EditInfoC.mbPhysPath in the member selector passed to checkoutSord or checkoutDoc to read the physical path.

    • previewUrl

      @Deprecated protected String previewUrl
      Deprecated.
      Use member preview instead

      URL to up-/download a document preview.

      Applies to document version. Is empty for signature and preview and fulltextContent.

    • sig

      protected DocVersion sig
      Document signature

      Applies to document version. Is null for signature and preview and fulltextContent.

    • preview

      protected DocVersion preview
      Document preview

      Applies to document version. Is null for signature and preview and fulltextContent.

      Since:
      6.00.087

    • size

      protected long size
      File size.

    • tStamp

      protected String tStamp
      Document timestamp

      Applies to document version and signature. Is undefined for preview. (Is available for fulltextContent)

      The format is JJJJ.MM.DD.hh.mm.ss

    • updateDateIso

      protected String updateDateIso
      Last update date. ClientInfo determines the Timezone.

      Applies to document version and signature. Is undefined for preview and fulltextContent.

    • uploadResult

      protected String uploadResult
      Result from the ELODM if the document was uploaded.

      Applies to document version, signature, preview and fulltextContent.

    • url

      protected String url
      URL to up-/download

      Applies to document version, signature,preview and fulltextContent.

    • version

      protected String version
      Version number

      Applies to document version. Is undefined for signature, preview and fulltextContent.

    • workVersion

      protected boolean workVersion
      Indicates whether the version is the current work version.

      Applies to document version. Is undefined for signature, preview and fulltextContent.

    • encryptionSet

      protected int encryptionSet
      ID of the encryption set. It's password is used to encrypt or decrypt the document. It a new document or version should be checked in, this member must be set to Sord.details.encryptionSet before checkinDocBegin is called. When this object is retrieved via IX it is always set to Sord.details.encryptionSet.

      Applies to document version. Is undefined for signature.

    • fulltextContent

      protected DocVersion fulltextContent
      This object provides the content of the fulltext database for the document version. The information is read-only and only available for DocVersion objects that refer to a document version (and not an attachment, preview or signature). Currenly, only the members url, ext, contentType and encryptionSet are valid for a DocVersion object that belongs to fulltext content. Whereby ext is always txt and contentType is always text/plain. A Byte Order Mark preceedes the content data. If the related document version is encrypted, the appropriate encryption password has to be set, before the fulltext information can be downloaded. If the SessionOptionC.DECRYPT_DOCUMENTS is not set, the fulltext information is transmitted encrypted.

      Applies to document version. Is undefined for signature and preview.

      Since:
      7.00.020.003

    • deleteDateIso

      protected String deleteDateIso
      Delete date. ClientInfo determines the Timezone.

      Is undefined if isDeleted() returns false.

      Since:
      9.00.000.000

    • nbOfValidSignatures

      protected int nbOfValidSignatures
      Number of valid signatures. This member holds the count of valid signatures in the signature file. It is only valid for a DocVersion object that represents a signature (member sig). A value of zero means, that the signatures are unchecked. A number greater than zero means, that all signatures are valid. In this case the member value is equal to the number of signatures. If at least one signature is invalid, the value is less than zero. The number of invalid signatures is thereby unknown. Client applications are responsible to check signatures. The ELOix does not check signatures.
      Since:
      9.00.016.002

    • relativeFilePath

      protected String relativeFilePath
      Relative file path for external file. This member specifies the location of the file relative to a custom path. If pathId does not refer a custom path, this member is empty and ignored in IXServicePortIF.checkinDocEnd(ClientInfo, Sord, SordZ, Document, LockZ).
      Since:
      9.00.030.023

    • tStampSync

      protected String tStampSync
      Timestamp of this object's ACLs last export by the replication.
      Since:
      9.99.009.001

    • language

      protected String language
      Language of the document content. This value is estimated by ELO Textreader when the document is sent for fulltext extraction. See TranslateTermC.DEFAULT_LANGUAGES for a list of language-tags.
      Since:
      21.04.000.001

  • Constructor Details

    • DocVersion

      public DocVersion()

    • DocVersion

      public DocVersion(DocVersion rhs)

  • Method Details

    • getRelativeFilePath

      public String getRelativeFilePath()

    • setRelativeFilePath

      public void setRelativeFilePath(String relativeFilePath)

    • getAccessDateIso

      public String getAccessDateIso()

    • setAccessDateIso

      public void setAccessDateIso(String accessDateIso)

    • getComment

      public String getComment()

    • setComment

      public void setComment(String comment)

    • getCreateDateIso

      public String getCreateDateIso()

    • setCreateDateIso

      public void setCreateDateIso(String createDateIso)

    • isDeleted

      public boolean isDeleted()

    • setDeleted

      public void setDeleted(boolean deleted)

    • getExt

      public String getExt()

    • setExt

      public void setExt(String ext)

    • getFileData

      public FileData getFileData()

    • setFileData

      public void setFileData(FileData fileData)

    • getGuid

      public String getGuid()

    • setGuid

      public void setGuid(String guid)

    • getId

      public int getId()

    • setId

      public void setId(int id)

    • getMd5

      public String getMd5()

    • setMd5

      public void setMd5(String md5)

    • isMilestone

      public boolean isMilestone()

    • setMilestone

      public void setMilestone(boolean milestone)

    • getOwnerId

      public int getOwnerId()

    • setOwnerId

      public void setOwnerId(int ownerId)

    • getOwnerName

      public String getOwnerName()

    • setOwnerName

      public void setOwnerName(String ownerName)

    • getPathId

      public int getPathId()

    • setPathId

      public void setPathId(int pathId)

    • getPathId2

      public int getPathId2()

    • setPathId2

      public void setPathId2(int pathId2)

    • getPhysPath

      public String getPhysPath()

    • setPhysPath

      public void setPhysPath(String physPath)

    • getPreviewUrl

      @Deprecated public String getPreviewUrl()
      Deprecated.

    • setPreviewUrl

      @Deprecated public void setPreviewUrl(String previewUrl)
      Deprecated.

    • getSig

      public DocVersion getSig()

    • setSig

      public void setSig(DocVersion sig)

    • getSize

      public long getSize()

    • setSize

      public void setSize(long size)

    • getTStamp

      public String getTStamp()

    • setTStamp

      public void setTStamp(String tStamp)

    • getUpdateDateIso

      public String getUpdateDateIso()

    • setUpdateDateIso

      public void setUpdateDateIso(String updateDateIso)

    • getUploadResult

      public String getUploadResult()

    • setUploadResult

      public void setUploadResult(String uploadResult)

    • getUrl

      public String getUrl()

    • setUrl

      public void setUrl(String url)

    • getVersion

      public String getVersion()

    • setVersion

      public void setVersion(String version)

    • isWorkVersion

      public boolean isWorkVersion()

    • setWorkVersion

      public void setWorkVersion(boolean workVersion)

    • getEncryptionSet

      public int getEncryptionSet()

    • setEncryptionSet

      public void setEncryptionSet(int encryptionSet)

    • getPreview

      public DocVersion getPreview()

    • setPreview

      public void setPreview(DocVersion preview)

    • getContentType

      public String getContentType()

    • setContentType

      public void setContentType(String contentType)

    • getFulltextContent

      public DocVersion getFulltextContent()

    • setFulltextContent

      public void setFulltextContent(DocVersion fulltextContent)

    • getDeleteDateIso

      public String getDeleteDateIso()

    • setDeleteDateIso

      public void setDeleteDateIso(String deleteDateIso)

    • getNbOfValidSignatures

      public int getNbOfValidSignatures()

    • setNbOfValidSignatures

      public void setNbOfValidSignatures(int nbOfValidSignatures)

    • getTStampSync

      public String getTStampSync()

    • setTStampSync

      public void setTStampSync(String tStampSync)

    • setLanguage

      public void setLanguage(String language)

    • getLanguage

      public String getLanguage()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object