org.nuxeo.ecm.mobile.webengine.document

Class MobileDocument

java.lang.Object

org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>

org.nuxeo.ecm.webengine.model.impl.DefaultObject

org.nuxeo.ecm.core.rest.DocumentObject

org.nuxeo.ecm.mobile.webengine.document.MobileDocument

All Implemented Interfaces:

Resource, Adaptable

public class MobileDocument
extends DocumentObject

This Class resolve a DocumentModel and expose differents restitutions according Adapter defined (PreviewAdapter, CommentAdapter) in uri and "mode" parameter given as parameter into the url. Default mode if given doesn't exist or not set is view mode.

Since:

5.5

Author:

Benjamin JALON

Constructor Summary

Constructors

Constructor and Description
MobileDocument(WebContext ctx, DocumentRef docRef)

Method Summary

Methods

Modifier and Type	Method and Description
Object	doGet()
Object	doHasLiked()
Object	doLike()
Object	emailToCurrentPrincipal()
String	getDisplayPrincipalName()
String	getDisplayPrincipalName(Object object) Return the display name of an expected principal.
String	getDisplayPrincipalName(String name)
String	getDownloadURL()
String	getDownloadURL(DocumentModel docModel)
String	getJSFURLPath()
String	getJSFURLPath(DocumentModel docModel)
String	getPreviewURL()
NuxeoPrincipal	getPrincipal()
boolean	hasPreview()
Object	redirectToRealURL() Needed to not break the navigation after a false PUT see NXP-8778 as I'm redirected to this /@put URL

Methods inherited from class org.nuxeo.ecm.core.rest.DocumentObject

doDelete, doHead, doPost, doPut, getAdapter, getCoreSession, getDelete, getDocument, getPut, getTitle, initialize, newDocument, newDocument, newDocument, search, traverse

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.DefaultObject

disptachAdapter, isAdapter

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

checkGuard, dispose, getActiveAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MobileDocument

public MobileDocument(WebContext ctx,
              DocumentRef docRef)

Method Detail

redirectToRealURL

public Object redirectToRealURL()

Needed to not break the navigation after a false PUT see NXP-8778 as I'm redirected to this /@put URL

emailToCurrentPrincipal

public Object emailToCurrentPrincipal()

doLike

public Object doLike()

doHasLiked

public Object doHasLiked()

doGet

public Object doGet()

Overrides:

doGet in class DocumentObject

hasPreview

public boolean hasPreview()
                   throws ClientException

Throws:

ClientException

getPrincipal

public NuxeoPrincipal getPrincipal()

getJSFURLPath

public String getJSFURLPath(DocumentModel docModel)
                     throws Exception

Throws:

Exception

getDownloadURL

public String getDownloadURL()
                      throws Exception

Throws:

Exception

getDownloadURL

public String getDownloadURL(DocumentModel docModel)
                      throws Exception

Throws:

Exception

getJSFURLPath

public String getJSFURLPath()
                     throws Exception

Throws:

Exception

getPreviewURL

public String getPreviewURL()

getDisplayPrincipalName

public String getDisplayPrincipalName(String name)

getDisplayPrincipalName

public String getDisplayPrincipalName(Object object)

Return the display name of an expected principal. It passes as an Object to prevent Freemarker to thrown an exception when creator is null.

Parameters:

object - must be of type org.nuxeo.ecm.core.api.NuxeoPrincipal

Returns:

the display name will be empty if not a NuxeoPrincipal

getDisplayPrincipalName

public String getDisplayPrincipalName()