Package com.logicaldoc.core.document
Class Document
java.lang.Object
com.logicaldoc.core.PersistentObject
com.logicaldoc.core.metadata.ExtensibleObject
com.logicaldoc.core.document.AbstractDocument
com.logicaldoc.core.document.Document
- All Implemented Interfaces:
Extensible
,Secure<DocumentAccessControlEntry>
,TransactionalObject
,Serializable
- Direct Known Subclasses:
Hit
@Entity
public class Document
extends AbstractDocument
implements Secure<DocumentAccessControlEntry>
Basic concrete implementation of
AbstractDocument
- Since:
- 1.0
- Author:
- Marco Meschieri - LogicalDOC
- See Also:
-
Field Summary
Fields inherited from class com.logicaldoc.core.document.AbstractDocument
EXPORT_LOCKED, EXPORT_UNLOCKED, NATURE_DOC
Fields inherited from class com.logicaldoc.core.PersistentObject
DELETED_CODE_DEFAULT, DELETED_CODE_STRONG, id
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a new entry, replacing a previous one with the same groupId.void
void
void
copyAttributes
(AbstractDocument docVO) Copies in the current instance the attributes of the passed values object, but NOT the IDboolean
getAccessControlEntry
(long groupId) If the document is an alias, it is the id of the referenced documentRetrieve the folder owning this documentlong
getIcon()
The icon for this document, it may be kept from file name extensiongetTags()
The set of tags for this document.int
hashCode()
void
setAccessControlList
(Set<DocumentAccessControlEntry> accessControlList) void
setAttributes
(Map<String, Attribute> attributes) void
setDeleteUser
(String deleteUser) void
void
setDocRefType
(String docRefType) void
void
void
void
setTagsFromWords
(Set<String> tgs) void
setTemplate
(Template template) Methods inherited from class com.logicaldoc.core.document.AbstractDocument
getBarcoded, getBarcodeTemplateId, getColor, getComment, getCreator, getCreatorId, getCustomId, getDate, getDecodedPassword, getDeleteUserId, getDigest, getDocAttrs, getExportId, getExportName, getExportStatus, getExportVersion, getExtResId, getFileExtension, getFileName, getFileSize, getFileVersion, getFormId, getImmutable, getIndexed, getLanguage, getLastNote, getLinks, getLocale, getLockUser, getLockUserId, getNature, getOcrd, getOcrTemplateId, getPages, getPassword, getPreviewPages, getPublished, getPublisher, getPublisherId, getSigned, getStamped, getStartPublishing, getStatus, getStopPublishing, getTemplateId, getTemplateName, getTgs, getTitle, getTransactionId, getType, getVersion, getWorkflowStatus, getWorkflowStatusDisplay, isGranted, isModified, isPasswordProtected, isPublishing, isToIndex, setBarcoded, setBarcodeTemplateId, setColor, setComment, setCreator, setCreatorId, setCustomId, setDate, setDecodedPassword, setDeleteUserId, setDigest, setDocAttrs, setExportId, setExportName, setExportStatus, setExportVersion, setExtResId, setFileName, setFileSize, setFileVersion, setFormId, setImmutable, setIndexingStatus, setIndexingStatus, setLanguage, setLastNote, setLinks, setLocale, setLockUser, setLockUserId, setModified, setNature, setOcrd, setOcrTemplateId, setPages, setPassword, setPreviewPages, setPublished, setPublisher, setPublisherId, setSigned, setStamped, setStartPublishing, setStatus, setStatus, setStopPublishing, setTemplateId, setTemplateName, setTgs, setTransactionId, setType, setVersion, setWorkflowStatus, setWorkflowStatusDisplay, toString
Methods inherited from class com.logicaldoc.core.metadata.ExtensibleObject
getAttribute, getAttributeAtPosition, getAttributeNames, getAttributeNames, getValue, getValueAttributes, getValues, removeAttribute, setAttribute, setValue, setValues
Methods inherited from class com.logicaldoc.core.PersistentObject
getCreation, getDeleted, getId, getLastModified, getRecordVersion, getTenantId, setCreation, setDeleted, setId, setLastModified, setRecordVersion, setTenantId
-
Constructor Details
-
Document
public Document() -
Document
-
-
Method Details
-
getAttributes
- Specified by:
getAttributes
in interfaceExtensible
-
setAttributes
- Specified by:
setAttributes
in interfaceExtensible
-
getRating
-
setRating
-
getDocRefType
-
setDocRefType
-
getDocRef
If the document is an alias, it is the id of the referenced document- Returns:
- identifier of the referenced document
-
setDocRef
-
getDeleteUser
-
setDeleteUser
-
getFolder
Retrieve the folder owning this document- Returns:
- the parent folder
-
getFolderId
public long getFolderId()- Specified by:
getFolderId
in classAbstractDocument
-
setFolder
-
getTags
The set of tags for this document.- Returns:
- the set of tags
-
setTags
-
setTagsFromWords
- Overrides:
setTagsFromWords
in classAbstractDocument
-
getTagsAsWords
-
getTagsString
-
addTag
-
clearTags
public void clearTags() -
getIcon
Description copied from class:AbstractDocument
The icon for this document, it may be kept from file name extension- Overrides:
getIcon
in classAbstractDocument
- Returns:
- name of the icon file
-
copyAttributes
Copies in the current instance the attributes of the passed values object, but NOT the ID- Overrides:
copyAttributes
in classAbstractDocument
- Parameters:
docVO
- the document to get the attributes from
-
getTemplate
- Specified by:
getTemplate
in interfaceExtensible
-
setTemplate
- Specified by:
setTemplate
in interfaceExtensible
-
getAccessControlList
- Specified by:
getAccessControlList
in interfaceSecure<DocumentAccessControlEntry>
-
setAccessControlList
- Specified by:
setAccessControlList
in interfaceSecure<DocumentAccessControlEntry>
-
getAccessControlEntry
- Specified by:
getAccessControlEntry
in interfaceSecure<DocumentAccessControlEntry>
-
addAccessControlEntry
Description copied from interface:Secure
Adds a new entry, replacing a previous one with the same groupId.- Specified by:
addAccessControlEntry
in interfaceSecure<DocumentAccessControlEntry>
- Parameters:
ace
- the access control entry to add
-
hashCode
public int hashCode()- Overrides:
hashCode
in classAbstractDocument
-
equals
- Overrides:
equals
in classAbstractDocument
-