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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GUIVersion
```
public class GUIDocument
extends GUIExtensibleObject
implements Serializable
```
Representation of a single document handled by the GUI

Since:

6.0

Author:

Marco Meschieri - LogicalDOC

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static int DOC_LOCKED

static int DOC_UNLOCKED

Constructor Summary

Constructors
Constructor Description

GUIDocument()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addTag(String tag)`
`void`	`clearTags()`
`boolean`	`equals(Object obj)`
`int`	`getBarcoded()`
`Long`	`getBarcodeTemplateId()`
`String`	`getColor()`
`String`	`getComment()`
`Date`	`getCreation()`
`String`	`getCreator()`
`Long`	`getCreatorId()`
`String`	`getCustomId()`
`Date`	`getDate()`
`Long`	`getDocRef()`
`String`	`getDocRefType()`
`String`	`getExtResId()`
`String`	`getFileName()`
`Float`	`getFileSize()`
`String`	`getFileVersion()`
`GUIFolder`	`getFolder()`
`Long`	`getFormId()`
`String`	`getIcon()`
`int`	`getImmutable()`
`int`	`getIndexed()`
`String`	`getLanguage()`
`Date`	`getLastModified()`
`int`	`getLinks()`
`String`	`getLockUser()`
`Long`	`getLockUserId()`
`int`	`getNature()`
`String`	`getNotifyMessage()`
`long[]`	`getNotifyUsers()`
`int`	`getOcrd()`
`Long`	`getOcrTemplateId()`
`int`	`getPages()`
`String`	`getPathExtended()`
`int`	`getPreviewPages()`
`int`	`getPublished()`
`String`	`getPublisher()`
`Long`	`getPublisherId()`
`int`	`getRating()`
`int`	`getScore()`
`int`	`getSigned()`
`int`	`getStamped()`
`Date`	`getStartPublishing()`
`int`	`getStatus()`
`Date`	`getStopPublishing()`
`String`	`getSummary()`
`String[]`	`getTags()`
`String`	`getTagsString()`
`long`	`getTenantId()`
`String`	`getTgs()`
`String`	`getType()`
`String`	`getVersion()`
`String`	`getWorkflowStatus()`
`String`	`getWorkflowStatusDisplay()`
`int`	`hashCode()`
`boolean`	`isBookmarked()`
`boolean`	`isBulkUpdate()`
`boolean`	`isPasswordProtected()`
`void`	`removeTag(String tag)`
`void`	`setBarcoded(int barcoded)`
`void`	`setBarcodeTemplateId(Long barcodeTemplateId)`
`void`	`setBookmarked(boolean bookmarked)`
`void`	`setBulkUpdate(boolean bulkUpdate)`
`void`	`setColor(String color)`
`void`	`setComment(String comment)`
`void`	`setCreation(Date creation)`
`void`	`setCreator(String creator)`
`void`	`setCreatorId(Long creatorId)`
`void`	`setCustomId(String customId)`
`void`	`setDate(Date date)`
`void`	`setDocRef(Long docRef)`
`void`	`setDocRefType(String docRefType)`
`void`	`setExtResId(String extResId)`
`void`	`setFileName(String fileName)`
`void`	`setFileSize(Float fileSize)`
`void`	`setFileVersion(String fileVersion)`
`void`	`setFolder(GUIFolder folder)`
`void`	`setFormId(Long formId)`
`void`	`setIcon(String icon)`
`void`	`setImmutable(int immutable)`
`void`	`setIndexed(int indexed)`
`void`	`setLanguage(String language)`
`void`	`setLastModified(Date lastModified)`
`void`	`setLinks(int links)`
`void`	`setLockUser(String lockUser)`
`void`	`setLockUserId(Long lockUserId)`
`void`	`setNature(int nature)`
`void`	`setNotifyMessage(String notifyMessage)`
`void`	`setNotifyUsers(long[] notifyUsers)`
`void`	`setOcrd(int ocrd)`
`void`	`setOcrTemplateId(Long ocrTemplateId)`
`void`	`setPages(int pages)`
`void`	`setPasswordProtected(boolean passwordProtected)`
`void`	`setPathExtended(String pathExtended)`
`void`	`setPreviewPages(int previewPages)`
`void`	`setPublished(int published)`
`void`	`setPublisher(String publisher)`
`void`	`setPublisherId(Long publisherId)`
`void`	`setRating(int rating)`
`void`	`setScore(int score)`
`void`	`setSigned(int signed)`
`void`	`setStamped(int stamped)`
`void`	`setStartPublishing(Date startPublishing)`
`void`	`setStatus(int status)`
`void`	`setStopPublishing(Date stopPublishing)`
`void`	`setSummary(String summary)`
`void`	`setTags(String[] tags)`
`void`	`setTagsString(String tagsString)`
`void`	`setTenantId(long tenantId)`
`void`	`setType(String type)`
`void`	`setVersion(String version)`
`void`	`setWorkflowStatus(String workflowStatus)`
`void`	`setWorkflowStatusDisplay(String workflowStatusDisplay)`

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

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

Field Detail
- DOC_LOCKED
```
public static final int DOC_LOCKED
```
  See Also:
  
  Constant Field Values
- DOC_UNLOCKED
```
public static final int DOC_UNLOCKED
```
  See Also:
  
  Constant Field Values

Constructor Detail
- GUIDocument
```
public GUIDocument()
```

Method Detail

getCustomId
```
public String getCustomId()
```

setCustomId

public void setCustomId(String customId)

getType
```
public String getType()
```

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

getVersion
```
public String getVersion()
```

setVersion

public void setVersion(String version)

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

setTags

public void setTags(String[] tags)

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

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

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

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

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

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

setCreator

public void setCreator(String creator)

getDate
```
public Date getDate()
```

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

getPublisher
```
public String getPublisher()
```

setPublisher

public void setPublisher(String publisher)

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

setCreation

public void setCreation(Date creation)

getFileVersion
```
public String getFileVersion()
```

setFileVersion

public void setFileVersion(String fileVersion)

getFileName
```
public String getFileName()
```

setFileName

public void setFileName(String fileName)

getLanguage
```
public String getLanguage()
```

setLanguage

public void setLanguage(String language)

getFileSize
```
public Float getFileSize()
```

setFileSize

public void setFileSize(Float fileSize)

getLastModified
```
public Date getLastModified()
```

setLastModified

public void setLastModified(Date lastModified)

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

getIcon
```
public String getIcon()
```

setIcon
```
public void setIcon(String icon)
```

getLockUserId
```
public Long getLockUserId()
```

setLockUserId

public void setLockUserId(Long lockUserId)

getStatus
```
public int getStatus()
```

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

getFolder
```
public GUIFolder getFolder()
```

setFolder

public void setFolder(GUIFolder folder)

getImmutable
```
public int getImmutable()
```

setImmutable

public void setImmutable(int immutable)

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

setPathExtended

public void setPathExtended(String pathExtended)

getRating
```
public int getRating()
```

setRating
```
public void setRating(int rating)
```

getComment
```
public String getComment()
```

setComment

public void setComment(String comment)

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

setWorkflowStatus

public void setWorkflowStatus(String workflowStatus)

getWorkflowStatusDisplay

public String getWorkflowStatusDisplay()

setWorkflowStatusDisplay

public void setWorkflowStatusDisplay(String workflowStatusDisplay)

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)

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

setBarcoded

public void setBarcoded(int barcoded)

getSummary
```
public String getSummary()
```

setSummary

public void setSummary(String summary)

getScore
```
public int getScore()
```

setScore
```
public void setScore(int score)
```

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

setIndexed

public void setIndexed(int indexed)

getSigned
```
public int getSigned()
```

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

getDocRef
```
public Long getDocRef()
```

setDocRef

public void setDocRef(Long docRef)

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

setExtResId

public void setExtResId(String extResId)

getDocRefType
```
public String getDocRefType()
```

setDocRefType

public void setDocRefType(String docRefType)

getPages
```
public int getPages()
```

setPages
```
public void setPages(int pages)
```

setTagsString

public void setTagsString(String tagsString)

getStamped
```
public int getStamped()
```

setStamped

public void setStamped(int stamped)

getNature
```
public int getNature()
```

setNature
```
public void setNature(int nature)
```

getFormId
```
public Long getFormId()
```

setFormId

public void setFormId(Long formId)

getLockUser
```
public String getLockUser()
```

setLockUser

public void setLockUser(String lockUser)

getNotifyUsers
```
public long[] getNotifyUsers()
```

setNotifyUsers

public void setNotifyUsers(long[] notifyUsers)

getNotifyMessage
```
public String getNotifyMessage()
```

setNotifyMessage

public void setNotifyMessage(String notifyMessage)

isPasswordProtected
```
public boolean isPasswordProtected()
```

setPasswordProtected

public void setPasswordProtected(boolean passwordProtected)

isBookmarked
```
public boolean isBookmarked()
```

setBookmarked

public void setBookmarked(boolean bookmarked)

getLinks
```
public int getLinks()
```

setLinks
```
public void setLinks(int links)
```

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

setOcrTemplateId

public void setOcrTemplateId(Long ocrTemplateId)

getOcrd
```
public int getOcrd()
```

setOcrd
```
public void setOcrd(int ocrd)
```

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

setBarcodeTemplateId

public void setBarcodeTemplateId(Long barcodeTemplateId)

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

setCreatorId

public void setCreatorId(Long creatorId)

getPublisherId
```
public Long getPublisherId()
```

setPublisherId

public void setPublisherId(Long publisherId)

getPreviewPages
```
public int getPreviewPages()
```

setPreviewPages

public void setPreviewPages(int previewPages)

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

setColor

public void setColor(String color)

isBulkUpdate
```
public boolean isBulkUpdate()
```

setBulkUpdate

public void setBulkUpdate(boolean bulkUpdate)

getTenantId
```
public long getTenantId()
```

setTenantId

public void setTenantId(long tenantId)

Fields
Modifier and Type	Field	Description
`static int`	`DOC_LOCKED`
`static int`	`DOC_UNLOCKED`

Class GUIDocument

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

DOC_LOCKED

DOC_UNLOCKED

Constructor Detail

GUIDocument

Method Detail

getCustomId

setCustomId

getType

setType

getVersion

setVersion

getTags

setTags

clearTags

addTag

removeTag

getTgs

getTagsString

getCreator

setCreator

getDate

setDate

getPublisher

setPublisher

getCreation

setCreation

getFileVersion

setFileVersion

getFileName

setFileName

getLanguage

setLanguage

getFileSize

setFileSize

getLastModified

setLastModified

equals

hashCode

getIcon

setIcon

getLockUserId

setLockUserId

getStatus

setStatus

getFolder

setFolder

getImmutable

setImmutable

getPathExtended

setPathExtended

getRating

setRating

getComment

setComment

getWorkflowStatus

setWorkflowStatus

getWorkflowStatusDisplay

setWorkflowStatusDisplay

getPublished

setPublished

getStartPublishing

setStartPublishing

getStopPublishing

setStopPublishing

getBarcoded

setBarcoded

getSummary

setSummary

getScore

setScore

getIndexed

setIndexed

getSigned