WSDocument (logicaldoc 6.8.3 API)

java.lang.Object
- com.logicaldoc.webservice.document.WSDocument

All Implemented Interfaces:

Serializable
```
public class WSDocument
extends Object
implements Serializable
```
Web Service Document. Useful class to create repository Documents.

Since:

5.2

Author:

Matteo Caruso - Logical Objects

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DOC_CHECKED_OUT`
`static int`	`DOC_LOCKED`
`static int`	`DOC_UNLOCKED`
`static int`	`EXPORT_LOCKED`
`static int`	`EXPORT_UNLOCKED`
`static int`	`INDEX_INDEXED`
`static int`	`INDEX_SKIP`
`static int`	`INDEX_TO_INDEX`
`protected static org.slf4j.Logger`	`log`

Constructor Summary

Constructors
Constructor and Description

WSDocument()

Constructors
Constructor and Description
`WSDocument()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addExtendedAttribute(WSAttribute att)`
`WSAttribute`	`attribute(String name)`
`static WSDocument`	`fromDocument(AbstractDocument document)`
`String`	`getComment()`
`String`	`getCoverage()`
`String`	`getCreation()`
`String`	`getCreator()`
`long`	`getCreatorId()`
`String`	`getCustomId()`
`String`	`getDate()`
`Long`	`getDeleteUserId()`
`String`	`getDigest()`
`Long`	`getDocRef()`
`Long`	`getExportId()`
`String`	`getExportName()`
`int`	`getExportStatus()`
`String`	`getExportVersion()`
`WSAttribute[]`	`getExtendedAttributes()`
`String`	`getFileName()`
`long`	`getFileSize()`
`String`	`getFileVersion()`
`Long`	`getFolderId()`
`String`	`getIcon()`
`long`	`getId()`
`int`	`getImmutable()`
`int`	`getIndexed()`
`String`	`getLanguage()`
`String`	`getLastModified()`
`Long`	`getLockUserId()`
`String`	`getObject()`
`String`	`getPath()`
`int`	`getPublished()`
`String`	`getPublisher()`
`long`	`getPublisherId()`
`Integer`	`getRating()`
`String`	`getRecipient()`
`Integer`	`getScore()`
`int`	`getSigned()`
`String`	`getSource()`
`String`	`getSourceAuthor()`
`String`	`getSourceDate()`
`String`	`getSourceId()`
`String`	`getSourceType()`
`String`	`getStartPublishing()`
`int`	`getStatus()`
`String`	`getStopPublishing()`
`String`	`getSummary()`
`String[]`	`getTags()`
`Long`	`getTemplateId()`
`String`	`getTitle()`
`String`	`getType()`
`String`	`getVersion()`
`String`	`getWorkflowStatus()`
`Collection<String>`	`listAttributeNames()`
`void`	`setComment(String comment)`
`void`	`setCoverage(String coverage)`
`void`	`setCreation(String creation)`
`void`	`setCreator(String creator)`
`void`	`setCreatorId(long creatorId)`
`void`	`setCustomId(String customId)`
`void`	`setDate(String date)`
`void`	`setDeleteUserId(Long deleteUserId)`
`void`	`setDigest(String digest)`
`void`	`setDocRef(Long docRef)`
`void`	`setExportId(Long exportId)`
`void`	`setExportName(String exportName)`
`void`	`setExportStatus(int exportStatus)`
`void`	`setExportVersion(String exportVersion)`
`void`	`setExtendedAttributes(WSAttribute[] extendedAttributes)`
`void`	`setFileName(String fileName)`
`void`	`setFileSize(long fileSize)`
`void`	`setFileVersion(String fileVersion)`
`void`	`setFolderId(Long folderId)`
`void`	`setIcon(String icon)`
`void`	`setId(long id)`
`void`	`setImmutable(int immutable)`
`void`	`setIndexed(int indexed)`
`void`	`setLanguage(String language)`
`void`	`setLastModified(String lastModified)`
`void`	`setLockUserId(Long lockUserId)`
`void`	`setObject(String object)`
`void`	`setPath(String path)`
`void`	`setPublished(int published)`
`void`	`setPublisher(String publisher)`
`void`	`setPublisherId(long publisherId)`
`void`	`setRating(Integer rating)`
`void`	`setRecipient(String recipient)`
`void`	`setScore(Integer score)`
`void`	`setSigned(int signed)`
`void`	`setSource(String source)`
`void`	`setSourceAuthor(String sourceAuthor)`
`void`	`setSourceDate(String sourceDate)`
`void`	`setSourceId(String sourceId)`
`void`	`setSourceType(String sourceType)`
`void`	`setStartPublishing(String startPublishing)`
`void`	`setStatus(int status)`
`void`	`setStopPublishing(String stopPublishing)`
`void`	`setSummary(String summary)`
`void`	`setTags(String[] tags)`
`void`	`setTemplateId(Long templateId)`
`void`	`setTitle(String title)`
`void`	`setType(String type)`
`void`	`setVersion(String version)`
`void`	`setWorkflowStatus(String workflowStatus)`
`Document`	`toDocument()`

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

Field Detail
- log
```
protected static org.slf4j.Logger log
```
- DOC_UNLOCKED
```
public static final int DOC_UNLOCKED
```
  See Also:
  Constant Field Values
- DOC_CHECKED_OUT
```
public static final int DOC_CHECKED_OUT
```
  See Also:
  Constant Field Values
- DOC_LOCKED
```
public static final int DOC_LOCKED
```
  See Also:
  Constant Field Values
- EXPORT_UNLOCKED
```
public static final int EXPORT_UNLOCKED
```
  See Also:
  Constant Field Values
- EXPORT_LOCKED
```
public static final int EXPORT_LOCKED
```
  See Also:
  Constant Field Values
- INDEX_TO_INDEX
```
public static final int INDEX_TO_INDEX
```
  See Also:
  Constant Field Values
- INDEX_INDEXED
```
public static final int INDEX_INDEXED
```
  See Also:
  Constant Field Values
- INDEX_SKIP
```
public static final int INDEX_SKIP
```
  See Also:
  Constant Field Values

Constructor Detail
- WSDocument
```
public WSDocument()
```

Method Detail

fromDocument

public static WSDocument fromDocument(AbstractDocument document)

listAttributeNames

public Collection<String> listAttributeNames()

attribute

public WSAttribute attribute(String name)

toDocument

public Document toDocument()
                    throws Exception

Throws:: Exception

getFileSize
```
public long getFileSize()
```

setFileSize

public void setFileSize(long fileSize)

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

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

getExportStatus
```
public int getExportStatus()
```

setExportStatus

public void setExportStatus(int exportStatus)

getTitle
```
public String getTitle()
```

setTitle
```
public void setTitle(String title)
```

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

setVersion

public void setVersion(String version)

getExportVersion
```
public String getExportVersion()
```

setExportVersion

public void setExportVersion(String exportVersion)

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

setFileVersion

public void setFileVersion(String fileVersion)

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

setPublisher

public void setPublisher(String publisher)

getPublisherId
```
public long getPublisherId()
```

setPublisherId

public void setPublisherId(long publisherId)

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

setCreator

public void setCreator(String creator)

getCreatorId
```
public long getCreatorId()
```

setCreatorId

public void setCreatorId(long creatorId)

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

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

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

setLockUserId

public void setLockUserId(Long lockUserId)

getSource
```
public String getSource()
```

setSource
```
public void setSource(String source)
```

getSourceAuthor
```
public String getSourceAuthor()
```

setSourceAuthor

public void setSourceAuthor(String sourceAuthor)

getSourceId
```
public String getSourceId()
```

setSourceId

public void setSourceId(String sourceId)

getObject
```
public String getObject()
```

setObject
```
public void setObject(String object)
```

getSourceType
```
public String getSourceType()
```

setSourceType

public void setSourceType(String sourceType)

getCoverage
```
public String getCoverage()
```

setCoverage

public void setCoverage(String coverage)

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

setFileName

public void setFileName(String fileName)

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

setIndexed
```
public void setIndexed(int indexed)
```

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

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

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

setTags
```
public void setTags(String[] tags)
```

getFolderId
```
public Long getFolderId()
```

setFolderId

public void setFolderId(Long folderId)

getTemplateId
```
public Long getTemplateId()
```

setTemplateId

public void setTemplateId(Long templateId)

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

setCustomId

public void setCustomId(String customId)

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

setImmutable

public void setImmutable(int immutable)

getDigest
```
public String getDigest()
```

setDigest
```
public void setDigest(String digest)
```

getRecipient
```
public String getRecipient()
```

setRecipient

public void setRecipient(String recipient)

getExportName
```
public String getExportName()
```

setExportName

public void setExportName(String exportName)

getExportId
```
public Long getExportId()
```

setExportId

public void setExportId(Long exportId)

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

setDocRef
```
public void setDocRef(Long docRef)
```

getDeleteUserId
```
public Long getDeleteUserId()
```

setDeleteUserId

public void setDeleteUserId(Long deleteUserId)

getId
```
public long getId()
```

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

getDate
```
public String getDate()
```

setDate
```
public void setDate(String date)
```

getSourceDate
```
public String getSourceDate()
```

setSourceDate

public void setSourceDate(String sourceDate)

getCreation
```
public String getCreation()
```

setCreation

public void setCreation(String creation)

getExtendedAttributes

public WSAttribute[] getExtendedAttributes()

setExtendedAttributes

public void setExtendedAttributes(WSAttribute[] extendedAttributes)

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

setLanguage

public void setLanguage(String language)

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

setSummary

public void setSummary(String summary)

getScore
```
public Integer getScore()
```

setScore
```
public void setScore(Integer score)
```

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

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

getPath
```
public String getPath()
```

setPath
```
public void setPath(String path)
```

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

setComment

public void setComment(String comment)

getLastModified
```
public String getLastModified()
```

setLastModified

public void setLastModified(String lastModified)

getRating
```
public Integer getRating()
```

setRating

public void setRating(Integer rating)

addExtendedAttribute

public void addExtendedAttribute(WSAttribute att)

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

setWorkflowStatus

public void setWorkflowStatus(String workflowStatus)

getPublished
```
public int getPublished()
```

setPublished

public void setPublished(int published)

getStartPublishing
```
public String getStartPublishing()
```

setStartPublishing

public void setStartPublishing(String startPublishing)

getStopPublishing
```
public String getStopPublishing()
```

setStopPublishing

public void setStopPublishing(String stopPublishing)

Class WSDocument

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

DOC_UNLOCKED

DOC_CHECKED_OUT

DOC_LOCKED

EXPORT_UNLOCKED

EXPORT_LOCKED

INDEX_TO_INDEX

INDEX_INDEXED

INDEX_SKIP

Constructor Detail

WSDocument

Method Detail

fromDocument

listAttributeNames

attribute

toDocument

getFileSize

setFileSize

getStatus

setStatus

getExportStatus

setExportStatus

getTitle

setTitle

getVersion

setVersion

getExportVersion

setExportVersion

getFileVersion

setFileVersion

getPublisher

setPublisher

getPublisherId

setPublisherId

getCreator

setCreator

getCreatorId

setCreatorId

getType

setType

getLockUserId

setLockUserId

getSource

setSource

getSourceAuthor

setSourceAuthor

getSourceId

setSourceId

getObject

setObject

getSourceType

setSourceType

getCoverage

setCoverage

getFileName

setFileName

getIndexed

setIndexed

getSigned

setSigned

getTags

setTags

getFolderId

setFolderId

getTemplateId

setTemplateId

getCustomId

setCustomId

getImmutable

setImmutable

getDigest

setDigest

getRecipient

setRecipient