Package org.silverpeas.core.wopi

Class WopiEdition

java.lang.Object

org.silverpeas.core.wopi.WopiEdition

public class WopiEdition
extends Object

Represents the preparation of a wopi edition.

This object provides the following data:

• a WopiFile, the aimed file by the edition
• a WopiUser, the editor
• a client base URL that permits to access the online editor that takes in charge de WopiFile.mimeType()

Author:

silveryocha

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WopiEdition(WopiFile file, WopiUser user, String clientBaseUrl)

Method Summary

Modifier and Type	Method	Description
String	getClientBaseUrl()	The client base URL is the base URL which permits to load the WOPI editor which takes in charge the WopiFile into the WEB browser.
WopiFile	getFile()	Gets the WOPI file of the edition.
WopiUser	getUser()	Gets the WOPI user which is editing the file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WopiEdition

protected WopiEdition(WopiFile file,
                      WopiUser user,
                      String clientBaseUrl)

Method Detail

getFile

public WopiFile getFile()

Gets the WOPI file of the edition.

Returns:

a WopiFile instance.

getUser

public WopiUser getUser()

Gets the WOPI user which is editing the file.

Returns:

a WopiUser instance.

getClientBaseUrl

public String getClientBaseUrl()

The client base URL is the base URL which permits to load the WOPI editor which takes in charge the WopiFile into the WEB browser.

Returns:

an URL as string.