Package com.logicaldoc.core.folder

Class Folder

java.lang.Object
com.logicaldoc.core.PersistentObject
com.logicaldoc.core.metadata.ExtensibleObject
com.logicaldoc.core.folder.Folder
All Implemented Interfaces:
Extensible, Secure<FolderAccessControlEntry>, Serializable, Comparable<Folder>
@Entity public class Folder extends ExtensibleObject implements Secure<FolderAccessControlEntry>, 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 Details

  • Constructor Details

    • Folder

      public Folder()

    • Folder

      public Folder(Folder source)

    • Folder

      public Folder(String name)

  • Method Details

    • getAccessControlList

      public Set<FolderAccessControlEntry> getAccessControlList()
      Specified by:
      getAccessControlList in interface Secure<FolderAccessControlEntry>

    • setAccessControlList

      public void setAccessControlList(Set<FolderAccessControlEntry> accessControlList)
      Specified by:
      setAccessControlList in interface Secure<FolderAccessControlEntry>

    • isWorkspace

      public boolean isWorkspace()

    • isAlias

      public boolean isAlias()

    • getParentId

      public long getParentId()

    • setParentId

      public void setParentId(long parentId)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getSecurityRef

      public Long getSecurityRef()

    • setSecurityRef

      public void setSecurityRef(Long securityRef)

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • getType

      public int getType()

    • setType

      public void setType(int type)

    • getCreator

      public String getCreator()

    • setCreator

      public void setCreator(String creator)

    • getCreatorId

      public Long getCreatorId()

    • setCreatorId

      public void setCreatorId(Long creatorId)

    • getTemplateLocked

      public int getTemplateLocked()

    • setTemplateLocked

      public void setTemplateLocked(int templateLocked)

    • getDeleteUserId

      public Long getDeleteUserId()

    • setDeleteUserId

      public void setDeleteUserId(Long deleteUserId)

    • getPosition

      public int getPosition()

    • setPosition

      public void setPosition(int position)

    • getHidden

      public int getHidden()

    • setHidden

      public void setHidden(int hidden)

    • getQuotaDocs

      public Long getQuotaDocs()

    • setQuotaDocs

      public void setQuotaDocs(Long quotaDocs)

    • getQuotaSize

      public Long getQuotaSize()

    • setQuotaSize

      public void setQuotaSize(Long quotaSize)

    • getFoldRef

      public Long getFoldRef()

    • setFoldRef

      public void setFoldRef(Long foldRef)

    • getStore

      public Integer getStore()
      Gets the default store to use from this folder in the current node
      Returns:
      identifier of the default store

    • setStore

      public void setStore(Integer store)
      Gets the default store to use from this folder in the current node
      Parameters:
      store - identifier of the default store

    • getMaxVersions

      public Integer getMaxVersions()

    • setMaxVersions

      public void setMaxVersions(Integer maxVersions)

    • getColor

      public String getColor()

    • setColor

      public void setColor(String color)

    • getTags

      public Set<Tag> getTags()

    • setTags

      public void setTags(Set<Tag> tags)

    • getTgs

      public String getTgs()

    • setTgs

      public void setTgs(String tgs)
      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

      public void addTag(String word)

    • clearTags

      public void clearTags()

    • setTagsFromWords

      public void setTagsFromWords(Set<String> tgs)

    • getTagsAsWords

      public Set<String> getTagsAsWords()

    • getGrid

      public String getGrid()

    • setGrid

      public void setGrid(String grid)

    • getTagsString

      public String getTagsString()

    • getQuotaThreshold

      public Integer getQuotaThreshold()

    • setQuotaThreshold

      public void setQuotaThreshold(Integer quotaThreshold)

    • getQuotaAlertRecipients

      public String getQuotaAlertRecipients()

    • setQuotaAlertRecipients

      public void setQuotaAlertRecipients(String quotaAlertRecipients)

    • getQuotaAlertRecipientsAsList

      public List<String> getQuotaAlertRecipientsAsList()

    • addQuotaAlertRecipient

      public void addQuotaAlertRecipient(String recipient)

    • setPath

      public void setPath(String path)

    • getPath

      public String getPath()

    • getDeleteUser

      public String getDeleteUser()

    • setDeleteUser

      public void setDeleteUser(String deleteUser)

    • getPathExtended

      public String getPathExtended()

    • setPathExtended

      public void setPathExtended(String pathExtended)

    • getOcrTemplateId

      public Long getOcrTemplateId()

    • setOcrTemplateId

      public void setOcrTemplateId(Long ocrTemplateId)

    • getBarcodeTemplateId

      public Long getBarcodeTemplateId()

    • setBarcodeTemplateId

      public void setBarcodeTemplateId(Long barcodeTemplateId)

    • toString

      public String toString()
      Overrides:
      toString in class PersistentObject

    • getStores

      public Map<String,Integer> getStores()

    • setStores

      public void setStores(Map<String,Integer> stores)

    • getTile

      public String getTile()

    • setTile

      public void setTile(String tile)

    • getAttributes

      public Map<String,Attribute> getAttributes()
      Specified by:
      getAttributes in interface Extensible

    • setAttributes

      public void setAttributes(Map<String,Attribute> attributes)
      Specified by:
      setAttributes in interface Extensible

    • getTemplateId

      public Long getTemplateId()
      Specified by:
      getTemplateId in interface Extensible

    • setTemplateId

      public void setTemplateId(Long templateId)
      Specified by:
      setTemplateId in interface Extensible

    • getTemplateName

      public String getTemplateName()
      Specified by:
      getTemplateName in interface Extensible

    • setTemplateName

      public void setTemplateName(String templateName)
      Specified by:
      setTemplateName in interface Extensible

    • getTemplate

      public Template getTemplate()
      Specified by:
      getTemplate in interface Extensible

    • setTemplate

      public void setTemplate(Template template)
      Specified by:
      setTemplate in interface Extensible

    • getAccessControlEntry

      public AccessControlEntry getAccessControlEntry(long groupId)
      Specified by:
      getAccessControlEntry in interface Secure<FolderAccessControlEntry>

    • addAccessControlEntry

      public void addAccessControlEntry(FolderAccessControlEntry ace)
      Description copied from interface: Secure
      Adds a new entry, replacing a previous one with the same groupId.
      Specified by:
      addAccessControlEntry in interface Secure<FolderAccessControlEntry>
      Parameters:
      ace - the access control entry to add

    • compareTo

      public int compareTo(Folder other)
      Specified by:
      compareTo in interface Comparable<Folder>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class PersistentObject

    • equals

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