DocumentStatus (eXo OnlyOffice Editor :: Extension Services 1.5.0-M04 API)

java.lang.Object
- org.exoplatform.onlyoffice.DocumentStatus

```
public class DocumentStatus
extends Object
```
Onlyoffice Config status as described in callback handler documentation. Created by The eXo Platform SAS

Version:

$Id: DocumentStatus.java 00000 Feb 12, 2016 pnedonosko $

Author:

Peter Nedonosko

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DocumentStatus.Builder
The Class Builder.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DocumentStatus.Builder` The Class Builder.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`coEdited` The coedited.
`protected String`	`comment` The comment (used for saving a version of a document with comment on FileActivity)
`protected Config`	`config` The config.
`protected long`	`error` The error.
`protected Boolean`	`forceSaved` The forcesaved (true if a document is forcesaved via Editor bar)
`protected String`	`key` The key.
`protected Boolean`	`saved` The saved
`protected Long`	`status` The status.
`protected String`	`url` The url.
`protected String`	`userId` The userId (used for saving the document content under this user)
`protected String[]`	`users` The users.

Constructor Summary

Constructors
Constructor and Description

DocumentStatus()

Constructors
Constructor and Description
`DocumentStatus()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getComment()` Gets the comment.
`Config`	`getConfig()` Gets the config.
`long`	`getError()` Gets the error.
`String`	`getKey()` Gets the key.
`protected String`	`getLastUser()` Gets the last user (editor).
`protected Long`	`getStatus()` Gets the status returned by Onlyoffice Document Server.
`protected String`	`getUrl()` Gets the url.
`String`	`getUserId()` Gets the userId.
`protected String[]`	`getUsers()` Gets the users.
`Boolean`	`isCoedited()` Gets the coEdited.
`Boolean`	`isForcesaved()` Gets the forcesaved.
`Boolean`	`isSaved()` Gets the isSaved.
`protected void`	`setConfig(Config config)` Sets the config.
`protected String`	`toJSON()` Return this config as JSON string.

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

- Field Detail
  - key
```
protected String key
```
    The key.
  - status
```
protected Long status
```
    The status.
  - url
```
protected String url
```
    The url.
  - users
```
protected String[] users
```
    The users.
  - config
```
protected Config config
```
    The config.
  - error
```
protected long error
```
    The error.
  - coEdited
```
protected Boolean coEdited
```
    The coedited.
  - forceSaved
```
protected Boolean forceSaved
```
    The forcesaved (true if a document is forcesaved via Editor bar)
  - saved
```
protected Boolean saved
```
    The saved
  - userId
```
protected String userId
```
    The userId (used for saving the document content under this user)
  - comment
```
protected String comment
```
    The comment (used for saving a version of a document with comment on FileActivity)
- Constructor Detail
  - DocumentStatus
```
public DocumentStatus()
```
- Method Detail
  - getConfig
```
public Config getConfig()
```
    Gets the config.
    
    Returns:
    
    the config
  - getError
```
public long getError()
```
    Gets the error.
    
    Returns:
    
    the error
  - getKey
```
public String getKey()
```
    Gets the key.
    
    Returns:
    
    the key
  - setConfig
```
protected void setConfig(Config config)
```
    Sets the config.
    
    Parameters:
    
    config - the new config
  - getStatus
```
protected Long getStatus()
```
    Gets the status returned by Onlyoffice Document Server.
    See https://api.onlyoffice.com/editors/callback#status for details.
    
    Returns:
    
    the status
  - getUrl
```
protected String getUrl()
```
    Gets the url.
    
    Returns:
    
    the url
  - getUsers
```
protected String[] getUsers()
```
    Gets the users.
    
    Returns:
    
    the users
  - getLastUser
```
protected String getLastUser()
```
    Gets the last user (editor).
    
    Returns:
    
    the last user (editor)
  - isCoedited
```
public Boolean isCoedited()
```
    Gets the coEdited.
    
    Returns:
    
    the coEdited
  - isForcesaved
```
public Boolean isForcesaved()
```
    Gets the forcesaved.
    
    Returns:
    
    the forcesaved
  - isSaved
```
public Boolean isSaved()
```
    Gets the isSaved.
    
    Returns:
    
    the isSaved
  - getUserId
```
public String getUserId()
```
    Gets the userId.
    
    Returns:
    
    the userId
  - getComment
```
public String getComment()
```
    Gets the comment.
    
    Returns:
    
    the coment
  - toJSON
```
protected String toJSON()
                 throws org.exoplatform.ws.frameworks.json.impl.JsonException
```
    Return this config as JSON string.
    
    Returns:
    
    the string
    
    Throws:
    
    org.exoplatform.ws.frameworks.json.impl.JsonException - the json exception

Class DocumentStatus

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

key

status

url

users

config

error

coEdited

forceSaved

saved

userId

comment

Constructor Detail

DocumentStatus

Method Detail

getConfig

getError

getKey

setConfig

getStatus

getUrl

getUsers

getLastUser

isCoedited

isForcesaved

isSaved

getUserId

getComment

toJSON