AbstractDocument (logicaldoc 6.8.3 API)

java.lang.Object
- com.logicaldoc.core.PersistentObject
- - com.logicaldoc.core.ExtensibleObject
  - - com.logicaldoc.core.document.AbstractDocument

All Implemented Interfaces:

TransactionalObject

Direct Known Subclasses:

Document, Version
```
public abstract class AbstractDocument
extends ExtensibleObject
implements TransactionalObject
```
The Document is the central entity of LogicalDOC. A Document is a persistent business object and represents metadata over a single file stored into the DMS.
Each document has one or more Versions. The most recent version is the one used as default when we refer to a Document, but all previous versions are accessible from the history even if the are not indexed.
Each Version carries out two main informations, the version code itself that is called simply 'version', and the file version, called 'fileVersion'. The first identified the Version itself while the second refers to the file content. In general not all updates to a document involves the upload of a new file. A Document is written in a single language, this language defines the full-text index in which the document's content will be stored.

Since:

4.5

Author:

Marco Meschieri - Logical Objects

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BARCODE_PROCESSED`
`static int`	`BARCODE_SKIP`
`static int`	`BARCODE_TO_PROCESS`
`static int`	`DOC_CHECKED_OUT`
`static int`	`DOC_LOCKED`
`static int`	`DOC_UNLOCKED`
`static int`	`EXPORT_LOCKED`
`static int`	`EXPORT_UNLOCKED`
`static int`	`INDEX_INDEXED`
`static int`	`INDEX_SKIP`
`static int`	`INDEX_TO_INDEX`

Constructor Summary

Constructors
Constructor and Description

AbstractDocument()

Constructors
Constructor and Description
`AbstractDocument()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addTag(String word)`
`void`	`clearTags()`
`int`	`getBarcoded()`
`String`	`getComment()`
`String`	`getCoverage()` The coverage of the document (form document's metadata)
`Date`	`getCreation()` The document's creation date
`String`	`getCreator()`
`long`	`getCreatorId()`
`String`	`getCustomId()` Each document can be identified with a custom identifier
`Date`	`getDate()` The document's last publication date.
`Long`	`getDeleteUserId()`
`String`	`getDigest()` The document's digest
`Long`	`getDocRef()` If the document is an alias, it is the id of the referenced document
`Long`	`getExportId()` The last archive in which the document was exported
`String`	`getExportName()` The last archive name in which the document was exported
`int`	`getExportStatus()` The document export status
`String`	`getExportVersion()` The last exported version
`String`	`getExtResId()`
`String`	`getFileExtension()`
`String`	`getFileName()` The original file name
`long`	`getFileSize()` The document's file size expressed in bytes
`String`	`getFileVersion()` The working file version.
`Folder`	`getFolder()` Retrieve the folder owning this document
`String`	`getIcon()` The icon for this document, it may be kept from file name extension
`int`	`getImmutable()` Defines if the document is immutable
`int`	`getIndexed()`
`String`	`getLanguage()` The document's language.
`Locale`	`getLocale()`
`Long`	`getLockUserId()` The id of the user that locked this document and that currently locks it
`String`	`getObject()`
`int`	`getPublished()`
`String`	`getPublisher()` The username that published this document
`long`	`getPublisherId()` The user id of the user that published this document
`Integer`	`getRating()`
`String`	`getRecipient()` The document's recipient
`int`	`getSigned()` Return 1 if the document was signed
`String`	`getSource()` Indication of the document's source
`String`	`getSourceAuthor()` The author of the document (form document's metadata)
`Date`	`getSourceDate()` The date of the document (form document's metadata)
`String`	`getSourceId()`
`String`	`getSourceType()` The type of the document (form document's metadata)
`Date`	`getStartPublishing()`
`int`	`getStatus()` The document status
`Date`	`getStopPublishing()`
`Set<String>`	`getTags()` The set of tags for this document.
`String`	`getTagsString()`
`DocumentTemplate`	`getTemplate()`
`String`	`getTgs()`
`String`	`getTitle()` In general a document has a title.
`String`	`getTransactionId()` Unique ID of the transaction
`String`	`getType()` The document type
`String`	`getVersion()` The working version (the most recent version)
`String`	`getWorkflowStatus()`
`boolean`	`isPublishing()`
`boolean`	`isToIndex()`
`void`	`setBarcoded(int barcoded)`
`void`	`setComment(String comment)`
`void`	`setCoverage(String coverage)`
`void`	`setCreation(Date creation)`
`void`	`setCreator(String creator)`
`void`	`setCreatorId(long creatorId)`
`void`	`setCustomId(String customId)`
`void`	`setDate(Date date)`
`void`	`setDeleteUserId(Long deleteUserId)`
`void`	`setDigest(String digest)`
`void`	`setDocRef(Long docRef)`
`void`	`setExportId(Long exportId)`
`void`	`setExportName(String exportName)`
`void`	`setExportStatus(int exportStatus)`
`void`	`setExportVersion(String exportVersion)`
`void`	`setExtResId(String extResId)`
`void`	`setFileName(String fileName)`
`void`	`setFileSize(long fileSize)`
`void`	`setFileVersion(String fileVersion)`
`void`	`setFolder(Folder folder)`
`void`	`setImmutable(int immutable)`
`void`	`setIndexed(int indexed)`
`void`	`setLanguage(String language)`
`void`	`setLocale(Locale locale)`
`void`	`setLockUserId(Long lockUserId)`
`void`	`setObject(String object)`
`void`	`setPublished(int published)`
`void`	`setPublisher(String publisher)`
`void`	`setPublisherId(long publisherId)`
`void`	`setRating(Integer rating)`
`void`	`setRecipient(String recipient)`
`void`	`setSigned(int signed)`
`void`	`setSource(String source)`
`void`	`setSourceAuthor(String sourceAuthor)`
`void`	`setSourceDate(Date sourceDate)`
`void`	`setSourceId(String sourceId)`
`void`	`setSourceType(String sourceType)`
`void`	`setStartPublishing(Date startPublishing)`
`void`	`setStatus(int status)`
`void`	`setStopPublishing(Date stopPublishing)`
`void`	`setTags(Set<String> tags)`
`void`	`setTemplate(DocumentTemplate template)`
`void`	`setTgs(String tgs)`
`void`	`setTitle(String title)`
`void`	`setTransactionId(String transactionId)`
`void`	`setType(String type)`
`void`	`setVersion(String version)` Iterates over the versions searching for the specified id
`void`	`setWorkflowStatus(String workflowStatus)`

Methods inherited from class com.logicaldoc.core.ExtensibleObject
getAttributeAtPosition, getAttributeNames, getAttributes, getExtendedAttribute, getValue, removeAttribute, setAttributes, setValue

Methods inherited from class com.logicaldoc.core.PersistentObject
equals, getDeleted, getId, getLastModified, hashCode, setDeleted, setId, setLastModified, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail
- DOC_UNLOCKED
```
public static final int DOC_UNLOCKED
```
  See Also:
  Constant Field Values
- DOC_CHECKED_OUT
```
public static final int DOC_CHECKED_OUT
```
  See Also:
  Constant Field Values
- DOC_LOCKED
```
public static final int DOC_LOCKED
```
  See Also:
  Constant Field Values
- EXPORT_UNLOCKED
```
public static final int EXPORT_UNLOCKED
```
  See Also:
  Constant Field Values
- EXPORT_LOCKED
```
public static final int EXPORT_LOCKED
```
  See Also:
  Constant Field Values
- INDEX_TO_INDEX
```
public static final int INDEX_TO_INDEX
```
  See Also:
  Constant Field Values
- INDEX_INDEXED
```
public static final int INDEX_INDEXED
```
  See Also:
  Constant Field Values
- INDEX_SKIP
```
public static final int INDEX_SKIP
```
  See Also:
  Constant Field Values
- BARCODE_TO_PROCESS
```
public static final int BARCODE_TO_PROCESS
```
  See Also:
  Constant Field Values
- BARCODE_PROCESSED
```
public static final int BARCODE_PROCESSED
```
  See Also:
  Constant Field Values
- BARCODE_SKIP
```
public static final int BARCODE_SKIP
```
  See Also:
  Constant Field Values

Constructor Detail
- AbstractDocument
```
public AbstractDocument()
```

Method Detail

getDeleteUserId
```
public Long getDeleteUserId()
```

setDeleteUserId

public void setDeleteUserId(Long deleteUserId)

getStatus
```
public int getStatus()
```
The document status

See Also:
DOC_UNLOCKED, DOC_CHECKED_OUT, DOC_LOCKED

setStatus
```
public void setStatus(int status)
```

getTitle
```
public String getTitle()
```
In general a document has a title. This is not the file name, but sometimes the filename is used as title.

setTitle
```
public void setTitle(String title)
```

getVersion
```
public String getVersion()
```
The working version (the most recent version)

setVersion
```
public void setVersion(String version)
```
Iterates over the versions searching for the specified id

Parameters:
id - The version id

getDate
```
public Date getDate()
```
The document's last publication date. This date is altered by checkin operations.

setDate
```
public void setDate(Date date)
```

getPublisherId
```
public long getPublisherId()
```
The user id of the user that published this document

setPublisherId

public void setPublisherId(long publisherId)

getPublisher
```
public String getPublisher()
```
The username that published this document

setPublisher

public void setPublisher(String publisher)

getType
```
public String getType()
```
The document type

setType
```
public void setType(String type)
```

getLockUserId
```
public Long getLockUserId()
```
The id of the user that locked this document and that currently locks it

setLockUserId

public void setLockUserId(Long lockUserId)

getSource
```
public String getSource()
```
Indication of the document's source

setSource
```
public void setSource(String source)
```

getSourceAuthor
```
public String getSourceAuthor()
```
The author of the document (form document's metadata)

setSourceAuthor

public void setSourceAuthor(String sourceAuthor)

getSourceDate
```
public Date getSourceDate()
```
The date of the document (form document's metadata)

setSourceDate

public void setSourceDate(Date sourceDate)

getSourceType
```
public String getSourceType()
```
The type of the document (form document's metadata)

setSourceType

public void setSourceType(String sourceType)

getCoverage
```
public String getCoverage()
```
The coverage of the document (form document's metadata)

setCoverage

public void setCoverage(String coverage)

getLanguage
```
public String getLanguage()
```
The document's language. This attribute is very important because of it is used to select the right full-text index.

setLanguage
```
public void setLanguage(String language)
```
See Also:
setLanguage(java.lang.String)

getTags
```
public Set<String> getTags()
```
The set of tags for this document.

setTags

public void setTags(Set<String> tags)

getIndexed
```
public int getIndexed()
```

setIndexed
```
public void setIndexed(int indexed)
```

getTagsString
```
public String getTagsString()
```

getFileName
```
public String getFileName()
```
The original file name

setFileName

public void setFileName(String fileName)

getIcon
```
public String getIcon()
```
The icon for this document, it may be kept from file name extension

getFileSize
```
public long getFileSize()
```
The document's file size expressed in bytes

setFileSize

public void setFileSize(long fileSize)

getFolder
```
public Folder getFolder()
```
Retrieve the folder owning this document

setFolder
```
public void setFolder(Folder folder)
```

addTag
```
public void addTag(String word)
```

clearTags
```
public void clearTags()
```

getFileExtension
```
public String getFileExtension()
```

getTemplate
```
public DocumentTemplate getTemplate()
```

setTemplate

public void setTemplate(DocumentTemplate template)

getCreation
```
public Date getCreation()
```
The document's creation date

setCreation

public void setCreation(Date creation)

getCustomId
```
public String getCustomId()
```
Each document can be identified with a custom identifier

setCustomId

public void setCustomId(String customId)

getImmutable
```
public int getImmutable()
```
Defines if the document is immutable

setImmutable

public void setImmutable(int immutable)

getSourceId
```
public String getSourceId()
```

setSourceId

public void setSourceId(String sourceId)

getObject
```
public String getObject()
```

setObject
```
public void setObject(String object)
```

getDigest
```
public String getDigest()
```
The document's digest

setDigest
```
public void setDigest(String digest)
```

getRecipient
```
public String getRecipient()
```
The document's recipient

setRecipient

public void setRecipient(String recipient)

getSigned
```
public int getSigned()
```
Return 1 if the document was signed

setSigned
```
public void setSigned(int signed)
```

getFileVersion
```
public String getFileVersion()
```
The working file version. Sometimes the version of the document may differ from the file versions. In fact if a new version differs from metadata only, we it have to reference the old file.

setFileVersion

public void setFileVersion(String fileVersion)

getCreatorId
```
public long getCreatorId()
```

setCreatorId

public void setCreatorId(long creatorId)

getCreator
```
public String getCreator()
```

setCreator

public void setCreator(String creator)

getLocale
```
public Locale getLocale()
```

setLocale
```
public void setLocale(Locale locale)
```

getExportStatus
```
public int getExportStatus()
```
The document export status

See Also:
EXPORT_UNLOCKED, EXPORT_LOCKED

setExportStatus

public void setExportStatus(int exportStatus)

getExportVersion
```
public String getExportVersion()
```
The last exported version

setExportVersion

public void setExportVersion(String exportVersion)

getExportName
```
public String getExportName()
```
The last archive name in which the document was exported

setExportName

public void setExportName(String exportName)

getExportId
```
public Long getExportId()
```
The last archive in which the document was exported

setExportId

public void setExportId(Long exportId)

getDocRef
```
public Long getDocRef()
```
If the document is an alias, it is the id of the referenced document

setDocRef
```
public void setDocRef(Long docRef)
```

isToIndex
```
public boolean isToIndex()
```

getBarcoded
```
public int getBarcoded()
```

setBarcoded

public void setBarcoded(int barcoded)

getRating
```
public Integer getRating()
```

setRating

public void setRating(Integer rating)

getComment
```
public String getComment()
```
See Also:
getComment()

setComment
```
public void setComment(String comment)
```
See Also:
setComment(java.lang.String)

getWorkflowStatus
```
public String getWorkflowStatus()
```

setWorkflowStatus

public void setWorkflowStatus(String workflowStatus)

getPublished
```
public int getPublished()
```

setPublished

public void setPublished(int published)

getStartPublishing
```
public Date getStartPublishing()
```

setStartPublishing

public void setStartPublishing(Date startPublishing)

getStopPublishing
```
public Date getStopPublishing()
```

setStopPublishing

public void setStopPublishing(Date stopPublishing)

isPublishing
```
public boolean isPublishing()
```

getTransactionId
```
public String getTransactionId()
```
Description copied from interface: TransactionalObject

Unique ID of the transaction

Specified by:

getTransactionId in interface TransactionalObject

setTransactionId
```
public void setTransactionId(String transactionId)
```
Specified by:

setTransactionId in interface TransactionalObject

getTgs
```
public String getTgs()
```

setTgs
```
public void setTgs(String tgs)
```

getExtResId
```
public String getExtResId()
```

setExtResId

public void setExtResId(String extResId)

Class AbstractDocument

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.logicaldoc.core.ExtensibleObject

Methods inherited from class com.logicaldoc.core.PersistentObject

Methods inherited from class java.lang.Object

Field Detail

DOC_UNLOCKED

DOC_CHECKED_OUT

DOC_LOCKED

EXPORT_UNLOCKED

EXPORT_LOCKED

INDEX_TO_INDEX

INDEX_INDEXED

INDEX_SKIP

BARCODE_TO_PROCESS

BARCODE_PROCESSED

BARCODE_SKIP

Constructor Detail

AbstractDocument

Method Detail

getDeleteUserId

setDeleteUserId

getStatus

setStatus

getTitle

setTitle

getVersion

setVersion

getDate

setDate

getPublisherId

setPublisherId

getPublisher

setPublisher

getType

setType

getLockUserId

setLockUserId

getSource

setSource

getSourceAuthor

setSourceAuthor

getSourceDate

setSourceDate

getSourceType

setSourceType

getCoverage

setCoverage

getLanguage

setLanguage

getTags

setTags

getIndexed

setIndexed

getTagsString

getFileName

setFileName

getIcon

getFileSize

setFileSize

getFolder

setFolder

addTag

clearTags

getFileExtension

getTemplate

setTemplate

getCreation

setCreation

getCustomId

setCustomId

getImmutable

setImmutable

getSourceId

setSourceId

getObject

setObject

getDigest