fr.toutatice.portail.cms.nuxeo.portlets.document.helpers

Class DocumentHelper

java.lang.Object

fr.toutatice.portail.cms.nuxeo.portlets.document.helpers.DocumentHelper

public class DocumentHelper
extends Object

Utility class to get informations on Document object (Nuxeo automation client).

Author:

David Chevrier.

Method Summary

Modifier and Type	Method and Description
static String	computeNavPath(String path)
static String	getCheckinedWebIdFromDraft(org.nuxeo.ecm.automation.client.model.Document draft) Getter for document's webid for corresponding given draft.
static String	getDraftPath(org.nuxeo.ecm.automation.client.model.Document document) Getter for path of Draft of a document (if it has one).
static String	getName(org.nuxeo.ecm.automation.client.model.Document document)
static String	getParentWebId(org.osivia.portal.core.cms.CMSServiceCtx cmsCtx, org.osivia.portal.core.cms.CMSPublicationInfos pubInfos)
static String	getWebId(org.nuxeo.ecm.automation.client.model.Document document)
static boolean	hasDraft(org.nuxeo.ecm.automation.client.model.Document document)
static boolean	isDraft(org.nuxeo.ecm.automation.client.model.Document document)
static boolean	isFolder(org.nuxeo.ecm.automation.client.model.Document document)
static boolean	isInLiveMode(org.osivia.portal.core.cms.CMSServiceCtx cmsCtx, org.osivia.portal.core.cms.CMSPublicationInfos pubInfos) Controls if live mode is associated with the current document.
static boolean	isLeaf(org.nuxeo.ecm.automation.client.model.Document document)
static boolean	isLocalPublishLive(org.nuxeo.ecm.automation.client.model.Document document)
static boolean	isRemoteProxy(org.osivia.portal.core.cms.CMSServiceCtx cmsCtx, org.osivia.portal.core.cms.CMSPublicationInfos pubInfos) Checks if current document is a remote proxy.

Methods inherited from class java.lang.Object

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

Method Detail

isLeaf

public static boolean isLeaf(org.nuxeo.ecm.automation.client.model.Document document)

Parameters:

document -

Returns:

true if document is a leaf.

isFolder

public static boolean isFolder(org.nuxeo.ecm.automation.client.model.Document document)

Parameters:

document - studied document

Returns:

true if document is a folder.

isLocalPublishLive

public static boolean isLocalPublishLive(org.nuxeo.ecm.automation.client.model.Document document)

Parameters:

document -

Returns:

true if document is a live in a publish space.

isDraft

public static boolean isDraft(org.nuxeo.ecm.automation.client.model.Document document)

Parameters:

document -

Returns:

true if document is a draft in live space.

hasDraft

public static boolean hasDraft(org.nuxeo.ecm.automation.client.model.Document document)

Parameters:

document -

Returns:

true if document has a draft in live space.

isRemoteProxy

public static boolean isRemoteProxy(org.osivia.portal.core.cms.CMSServiceCtx cmsCtx,
                                    org.osivia.portal.core.cms.CMSPublicationInfos pubInfos)

Checks if current document is a remote proxy.

Parameters:

cmsCtx - CMS context

pubInfos - CMS publication informations

Returns:

true if current document is a remote proxy.

getParentWebId

public static String getParentWebId(org.osivia.portal.core.cms.CMSServiceCtx cmsCtx,
                                    org.osivia.portal.core.cms.CMSPublicationInfos pubInfos)
                             throws org.osivia.portal.core.cms.CMSException

Throws:

org.osivia.portal.core.cms.CMSException

isInLiveMode

public static boolean isInLiveMode(org.osivia.portal.core.cms.CMSServiceCtx cmsCtx,
                                   org.osivia.portal.core.cms.CMSPublicationInfos pubInfos)

Controls if live mode is associated with the current document.

Parameters:

cmsCtx - CMS context

pubInfos - CMS publication informations

Returns:

true if in live mode

getName

public static String getName(org.nuxeo.ecm.automation.client.model.Document document)

Parameters:

document -

Returns:

name (last segment path) of a document.

getWebId

public static String getWebId(org.nuxeo.ecm.automation.client.model.Document document)

Parameters:

document -

Returns:

WebId of given document.

getCheckinedWebIdFromDraft

public static String getCheckinedWebIdFromDraft(org.nuxeo.ecm.automation.client.model.Document draft)

Getter for document's webid for corresponding given draft.

Parameters:

draft -

Returns:

WebId of given draft.

getDraftPath

public static String getDraftPath(org.nuxeo.ecm.automation.client.model.Document document)

Getter for path of Draft of a document (if it has one).

Parameters:

document -

Returns:

draft path of document if it has a draft

computeNavPath

public static String computeNavPath(String path)

Parameters:

path -

Returns:

navigation path.