Package com.logicaldoc.core.folder
Class Folder
java.lang.Object
com.logicaldoc.core.PersistentObject
com.logicaldoc.core.metadata.ExtensibleObject
com.logicaldoc.core.security.SecurableExtensibleObject
com.logicaldoc.core.folder.Folder
- All Implemented Interfaces:
Securable
,Serializable
,Comparable<Folder>
This class represents the key concept of security of documents. The Folder is
used as an element to build hierarchies. With the AccessControlList you can associate
groups to a given folder and grant some permissions. Also setting the
recurityRef you can specify another reference folder that contains the
security policies.
Folders have a type: 0 for standard folders, 1 for workspaces.
- Version:
- 6.0
- Author:
- Marco Meschieri - LogicalDOC
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final long
static final String
static final long
static final int
static final int
static final int
Fields inherited from class com.logicaldoc.core.PersistentObject
DELETED_CODE_DEFAULT, DELETED_CODE_STRONG
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addQuotaAlertRecipient
(String recipient) void
void
int
boolean
getColor()
getGrid()
int
getName()
long
getPath()
int
Gets the default storage to use from this folder in the current nodegetTags()
int
getTgs()
getTile()
int
getType()
boolean
isAlias()
boolean
void
setBarcodeTemplateId
(Long barcodeTemplateId) void
void
setCreator
(String creator) void
setCreatorId
(Long creatorId) void
setDeleteUser
(String deleteUser) void
setDeleteUserId
(Long deleteUserId) void
setDescription
(String description) void
setFoldRef
(Long foldRef) void
void
setHidden
(int hidden) void
setMaxVersions
(Integer maxVersions) void
void
setOcrTemplateId
(Long ocrTemplateId) void
setParentId
(long parentId) void
void
setPathExtended
(String pathExtended) void
setPosition
(int position) void
setQuotaAlertRecipients
(String quotaAlertRecipients) void
setQuotaDocs
(Long quotaDocs) void
setQuotaSize
(Long quotaSize) void
setQuotaThreshold
(Integer quotaThreshold) void
setSecurityRef
(Long securityRef) void
setStorage
(Integer storage) Gets the default storage to use from this folder in the current nodevoid
setStorages
(Map<String, Integer> storages) void
void
setTagsFromWords
(Set<String> tgs) void
setTemplateLocked
(int templateLocked) void
So not invoke this method directly, it is thought to be used by the ORM inside the DAO.void
void
setType
(int type) toString()
Methods inherited from class com.logicaldoc.core.security.SecurableExtensibleObject
addAccessControlEntry, getAccessControlEntry, getAccessControlList, hashCode, setAccessControlList
Methods inherited from class com.logicaldoc.core.metadata.ExtensibleObject
getAttribute, getAttributeAtPosition, getAttributeNames, getAttributeNames, getAttributes, getTemplate, getTemplateId, getTemplateName, getValue, getValueAttributes, getValues, removeAttribute, setAttribute, setAttributes, setTemplate, setTemplateId, setTemplateName, setValue, setValues
Methods inherited from class com.logicaldoc.core.PersistentObject
getCreation, getDeleted, getId, getLastModified, getRecordVersion, getTenantId, setCreation, setDeleted, setId, setLastModified, setRecordVersion, setTenantId
-
Field Details
-
ROOTID
public static final long ROOTID- See Also:
-
DEFAULTWORKSPACEID
public static final long DEFAULTWORKSPACEID- See Also:
-
DEFAULTWORKSPACENAME
- See Also:
-
TYPE_DEFAULT
public static final int TYPE_DEFAULT- See Also:
-
TYPE_WORKSPACE
public static final int TYPE_WORKSPACE- See Also:
-
TYPE_ALIAS
public static final int TYPE_ALIAS- See Also:
-
-
Constructor Details
-
Folder
public Folder() -
Folder
-
Folder
-
-
Method Details
-
isWorkspace
public boolean isWorkspace() -
isAlias
public boolean isAlias() -
getParentId
public long getParentId() -
setParentId
public void setParentId(long parentId) -
compareTo
- Specified by:
compareTo
in interfaceComparable<Folder>
-
equals
- Overrides:
equals
in classSecurableExtensibleObject
-
getName
-
setName
-
getSecurityRef
-
setSecurityRef
-
getDescription
-
setDescription
-
getType
public int getType() -
setType
public void setType(int type) -
getCreator
-
setCreator
-
getCreatorId
-
setCreatorId
-
getTemplateLocked
public int getTemplateLocked() -
setTemplateLocked
public void setTemplateLocked(int templateLocked) -
getDeleteUserId
-
setDeleteUserId
-
getPosition
public int getPosition() -
setPosition
public void setPosition(int position) -
getHidden
public int getHidden() -
setHidden
public void setHidden(int hidden) -
getQuotaDocs
-
setQuotaDocs
-
getQuotaSize
-
setQuotaSize
-
getFoldRef
-
setFoldRef
-
getStorage
Gets the default storage to use from this folder in the current node- Returns:
- identifier of the default storage
-
setStorage
Gets the default storage to use from this folder in the current node- Parameters:
storage
- identifier of the default storage
-
getMaxVersions
-
setMaxVersions
-
getColor
-
setColor
-
getTags
-
setTags
-
getTgs
-
setTgs
So not invoke this method directly, it is thought to be used by the ORM inside the DAO.- Parameters:
tgs
- comma-separated string of tags
-
addTag
-
clearTags
public void clearTags() -
setTagsFromWords
-
getTagsAsWords
-
getGrid
-
setGrid
-
getTagsString
-
getQuotaThreshold
-
setQuotaThreshold
-
getQuotaAlertRecipients
-
setQuotaAlertRecipients
-
getQuotaAlertRecipientsAsList
-
addQuotaAlertRecipient
-
setPath
-
getPath
-
getDeleteUser
-
setDeleteUser
-
getPathExtended
-
setPathExtended
-
getOcrTemplateId
-
setOcrTemplateId
-
getBarcodeTemplateId
-
setBarcodeTemplateId
-
toString
- Overrides:
toString
in classPersistentObject
-
getStorages
-
setStorages
-
getTile
-
setTile
-