java.lang.Object
- com.logicaldoc.gui.common.client.beans.GUIExtensibleObject
- - com.logicaldoc.gui.common.client.beans.GUIFolder

All Implemented Interfaces:

Serializable
```
public class GUIFolder
extends GUIExtensibleObject
implements Serializable
```
Represents a folder from the GUI view

Since:

6.0

Author:

Marco Meschieri - LogicalDOC

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static int TYPE_ALIAS

static int TYPE_DEFAULT

static int TYPE_WORKSPACE

Constructor Summary

Constructors
Constructor Description

GUIFolder()

GUIFolder(long id)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addQuotaAlertRecipient(String recipient)`
`void`	`addTag(String tag)`
`void`	`clearQuotaAlertRecipients()`
`Long`	`getBarcodeTemplateId()`
`String`	`getColor()`
`Date`	`getCreation()`
`String`	`getCreator()`
`Long`	`getCreatorId()`
`String`	`getDescription()`
`int`	`getDocumentCount()`
`long`	`getDocumentsTotal()`
`Long`	`getFoldRef()`
`String`	`getGrid()`
`long`	`getId()`
`Integer`	`getMaxVersions()`
`String`	`getName()`
`Long`	`getOcrTemplateId()`
`GUIFolder`	`getParent()`
`long`	`getParentId()`
`GUIFolder[]`	`getPath()`
`String`	`getPathExtended()`
`String[]`	`getPermissions()`
`int`	`getPosition()`
`String[]`	`getQuotaAlertRecipients()`
`String`	`getQuotaAlertRecipientsAsString()`
`Long`	`getQuotaDocs()`
`Long`	`getQuotaSize()`
`Integer`	`getQuotaThreshold()`
`GUIRight[]`	`getRights()`
`GUIFolder`	`getSecurityRef()`
`long`	`getSizeTotal()`
`Integer`	`getStorage()`
`int`	`getSubfolderCount()`
`String[]`	`getTags()`
`String`	`getTagsString()`
`int`	`getTemplateLocked()`
`int`	`getType()`
`boolean`	`hasPermission(String permission)`
`boolean`	`isDefaultWorkspace()`
`boolean`	`isDelete()`
`boolean`	`isDownload()`
`boolean`	`isMove()`
`boolean`	`isRename()`
`boolean`	`isWorkspace()`
`boolean`	`isWrite()`
`GUIDocument`	`newDocument()`
`void`	`removeQuotaAlertRecipient(String recipient)`
`void`	`removeTag(String tag)`
`void`	`setBarcodeTemplateId(Long barcodeTemplateId)`
`void`	`setColor(String color)`
`void`	`setCreation(Date creation)`
`void`	`setCreator(String creator)`
`void`	`setCreatorId(Long creatorId)`
`void`	`setDescription(String description)`
`void`	`setDocumentCount(int documentCount)`
`void`	`setDocumentsTotal(long documentsTotal)`
`void`	`setFoldRef(Long foldRef)`
`void`	`setGrid(String grid)`
`void`	`setId(long id)`
`void`	`setMaxVersions(Integer maxVersions)`
`void`	`setName(String name)`
`void`	`setOcrTemplateId(Long ocrTemplateId)`
`void`	`setParentId(long parentId)`
`void`	`setPath(GUIFolder[] path)`
`void`	`setPathExtended(String pathExtended)`
`void`	`setPermissions(String[] permissions)`
`void`	`setPosition(int position)`
`void`	`setQuotaAlertRecipients(String[] quotaAlertRecipients)`
`void`	`setQuotaDocs(Long quotaDocs)`
`void`	`setQuotaSize(Long quotaSize)`
`void`	`setQuotaThreshold(Integer quotaThreshold)`
`void`	`setRights(GUIRight[] rights)`
`void`	`setSecurityRef(GUIFolder securityRef)`
`void`	`setSizeTotal(long sizeTotal)`
`void`	`setStorage(Integer storage)`
`void`	`setSubfolderCount(int subfolderCount)`
`void`	`setTags(String[] tags)`
`void`	`setTagsString(String tagsString)`
`void`	`setTemplateLocked(int templateLocked)`
`void`	`setType(int type)`
`String`	`toString()`

Methods inherited from class com.logicaldoc.gui.common.client.beans.GUIExtensibleObject
addAttribute, addAttributeValue, getAttribute, getAttributeNames, getAttributes, getTemplate, getTemplateId, getValue, getValues, putAttributeAfter, removeAttribute, setAttributes, setTemplate, setTemplateId, setValue, shiftValue, sortAttributes

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- TYPE_ALIAS
```
public static final int TYPE_ALIAS
```
  See Also:
  
  Constant Field Values
- TYPE_WORKSPACE
```
public static final int TYPE_WORKSPACE
```
  See Also:
  
  Constant Field Values
- TYPE_DEFAULT
```
public static final int TYPE_DEFAULT
```
  See Also:
  
  Constant Field Values

Constructor Detail

GUIFolder
```
public GUIFolder()
```

GUIFolder
```
public GUIFolder(long id)
```

Method Detail

isWorkspace
```
public boolean isWorkspace()
```

isDefaultWorkspace
```
public boolean isDefaultWorkspace()
```

getId
```
public long getId()
```
Overrides:

getId in class GUIExtensibleObject

setId
```
public void setId(long id)
```
Overrides:

setId in class GUIExtensibleObject

getPermissions
```
public String[] getPermissions()
```

setPermissions

public void setPermissions(String[] permissions)

isWrite
```
public boolean isWrite()
```

isDownload
```
public boolean isDownload()
```

isMove
```
public boolean isMove()
```

isDelete
```
public boolean isDelete()
```

isRename
```
public boolean isRename()
```

hasPermission

public boolean hasPermission(String permission)

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getPathExtended
```
public String getPathExtended()
```

setPathExtended

public void setPathExtended(String pathExtended)

getRights
```
public GUIRight[] getRights()
```

setRights

public void setRights(GUIRight[] rights)

getParentId
```
public long getParentId()
```

setParentId

public void setParentId(long parentId)

getPath
```
public GUIFolder[] getPath()
```

setPath

public void setPath(GUIFolder[] path)

getParent
```
public GUIFolder getParent()
```

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

setCreator

public void setCreator(String creator)

getCreatorId
```
public Long getCreatorId()
```

setCreatorId

public void setCreatorId(Long creatorId)

getCreation
```
public Date getCreation()
```

setCreation

public void setCreation(Date creation)

getDocumentCount
```
public int getDocumentCount()
```

setDocumentCount

public void setDocumentCount(int documentCount)

getSubfolderCount
```
public int getSubfolderCount()
```

setSubfolderCount

public void setSubfolderCount(int subfolderCount)

getType
```
public int getType()
```

setType
```
public void setType(int type)
```

getTemplateLocked
```
public int getTemplateLocked()
```

setTemplateLocked

public void setTemplateLocked(int templateLocked)

getSecurityRef
```
public GUIFolder getSecurityRef()
```

setSecurityRef

public void setSecurityRef(GUIFolder securityRef)

getPosition
```
public int getPosition()
```

setPosition

public void setPosition(int position)

getQuotaDocs
```
public Long getQuotaDocs()
```

setQuotaDocs

public void setQuotaDocs(Long quotaDocs)

getQuotaSize
```
public Long getQuotaSize()
```

setQuotaSize

public void setQuotaSize(Long quotaSize)

getDocumentsTotal
```
public long getDocumentsTotal()
```

setDocumentsTotal

public void setDocumentsTotal(long documentsTotal)

getSizeTotal
```
public long getSizeTotal()
```

setSizeTotal

public void setSizeTotal(long sizeTotal)

getFoldRef
```
public Long getFoldRef()
```

setFoldRef

public void setFoldRef(Long foldRef)

getStorage
```
public Integer getStorage()
```

setStorage

public void setStorage(Integer storage)

getMaxVersions
```
public Integer getMaxVersions()
```

setMaxVersions

public void setMaxVersions(Integer maxVersions)

getColor
```
public String getColor()
```

setColor

public void setColor(String color)

getTags
```
public String[] getTags()
```

setTags

public void setTags(String[] tags)

addTag
```
public void addTag(String tag)
```

removeTag
```
public void removeTag(String tag)
```

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

setTagsString

public void setTagsString(String tagsString)

getQuotaThreshold
```
public Integer getQuotaThreshold()
```

setQuotaThreshold

public void setQuotaThreshold(Integer quotaThreshold)

getQuotaAlertRecipients

public String[] getQuotaAlertRecipients()

getQuotaAlertRecipientsAsString

public String getQuotaAlertRecipientsAsString()

setQuotaAlertRecipients

public void setQuotaAlertRecipients(String[] quotaAlertRecipients)

clearQuotaAlertRecipients

public void clearQuotaAlertRecipients()

addQuotaAlertRecipient

public void addQuotaAlertRecipient(String recipient)

removeQuotaAlertRecipient

public void removeQuotaAlertRecipient(String recipient)

newDocument
```
public GUIDocument newDocument()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

getGrid
```
public String getGrid()
```

setGrid
```
public void setGrid(String grid)
```

getOcrTemplateId
```
public Long getOcrTemplateId()
```

setOcrTemplateId

public void setOcrTemplateId(Long ocrTemplateId)

getBarcodeTemplateId
```
public Long getBarcodeTemplateId()
```

setBarcodeTemplateId

public void setBarcodeTemplateId(Long barcodeTemplateId)

Modifier and Type	Field	Description
`static int`	`TYPE_ALIAS`
`static int`	`TYPE_DEFAULT`
`static int`	`TYPE_WORKSPACE`

Class GUIFolder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.logicaldoc.gui.common.client.beans.GUIExtensibleObject

Methods inherited from class java.lang.Object

Field Detail

TYPE_ALIAS

TYPE_WORKSPACE

TYPE_DEFAULT

Constructor Detail

GUIFolder

GUIFolder

Method Detail

isWorkspace

isDefaultWorkspace

getId

setId

getPermissions

setPermissions

isWrite

isDownload

isMove

isDelete

isRename

hasPermission

getDescription

setDescription

getName

setName

getPathExtended

setPathExtended

getRights

setRights

getParentId

setParentId

getPath

setPath

getParent

getCreator

setCreator

getCreatorId

setCreatorId

getCreation

setCreation

getDocumentCount

setDocumentCount

getSubfolderCount

setSubfolderCount

getType

setType

getTemplateLocked

setTemplateLocked

getSecurityRef

setSecurityRef

getPosition

setPosition

getQuotaDocs

setQuotaDocs

getQuotaSize

setQuotaSize

getDocumentsTotal

setDocumentsTotal

getSizeTotal

setSizeTotal

getFoldRef

setFoldRef

getStorage

setStorage

getMaxVersions

setMaxVersions

getColor

setColor

getTags

setTags

addTag

removeTag

getTagsString

setTagsString

getQuotaThreshold