org.exoplatform.onlyoffice

Class DocumentStatus

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	coEdited The coedited.
protected String	comment The comment.
protected Config	config The config.
protected long	error The error.
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()

Method Summary

Modifier and Type	Method and Description
protected String	getComment() Gets the comment.
Config	getConfig() Gets the config.
long	getError() Gets the error.
String	getKey() Gets the key.
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.
protected Boolean	isCoedited() Gets the coEdited.
protected Boolean	isSaved() Gets the isSaved.
protected void	setConfig(Config config) Sets the config.
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.

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. Will be used in Onlyoffice 1.5 for Editor Bar feature. (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

getLastUser

public String getLastUser()

Gets the last user (editor).

Returns:

the last user (editor)

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

isCoedited

protected Boolean isCoedited()

Gets the coEdited.

Returns:

the coEdited

isSaved

protected Boolean isSaved()

Gets the isSaved.

Returns:

the isSaved

getUserId

public String getUserId()

Gets the userId.

Returns:

the userId

getComment

protected String getComment()

Gets the comment.

Returns:

the coment

toJSON

public 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