org.nuxeo.ecm.platform.publisher.impl.finder

Class AbstractRootSectionsFinder

java.lang.Object

org.nuxeo.ecm.core.api.UnrestrictedSessionRunner

org.nuxeo.ecm.platform.publisher.impl.finder.AbstractRootSectionsFinder

All Implemented Interfaces:

RootSectionFinder

Direct Known Subclasses:

DefaultRootSectionsFinder

public abstract class AbstractRootSectionsFinder
extends UnrestrictedSessionRunner
implements RootSectionFinder

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCHEMA_PUBLISHING
static String	SECTIONS_PROPERTY_NAME

Fields inherited from class org.nuxeo.ecm.core.api.UnrestrictedSessionRunner

isUnrestricted

Constructor Summary

Constructors

Constructor and Description
AbstractRootSectionsFinder(CoreSession userSession)

Method Summary

Modifier and Type	Method and Description
DocumentModelList	getAccessibleSectionRoots(DocumentModel currentDoc)
DocumentModelList	getDefaultSectionRoots(boolean onlyHeads)
DocumentModelList	getDefaultSectionRoots(boolean onlyHeads, boolean addDefaultSectionRoots)
DocumentModelList	getSectionRootsForWorkspace(DocumentModel currentDoc) Returns the head (root) sections that are bound to a given Workspace.
DocumentModelList	getSectionRootsForWorkspace(DocumentModel currentDoc, boolean addDefaultSectionRoots) Returns the head (root) sections that are bound to a given Workspace.
void	reset()
void	run() This method will be called by UnrestrictedSessionRunner.runUnrestricted() with UnrestrictedSessionRunner.session available as an unrestricted session.

Methods inherited from class org.nuxeo.ecm.core.api.UnrestrictedSessionRunner

getOriginatingUsername, runUnrestricted, setOriginatingUsername

Methods inherited from class java.lang.Object

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

Field Detail

SCHEMA_PUBLISHING

public static final String SCHEMA_PUBLISHING

See Also:

Constant Field Values

SECTIONS_PROPERTY_NAME

public static final String SECTIONS_PROPERTY_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractRootSectionsFinder

public AbstractRootSectionsFinder(CoreSession userSession)

Method Detail

reset

public void reset()

Specified by:

reset in interface RootSectionFinder

getAccessibleSectionRoots

public DocumentModelList getAccessibleSectionRoots(DocumentModel currentDoc)
                                            throws ClientException

Specified by:

getAccessibleSectionRoots in interface RootSectionFinder

Throws:

ClientException

getSectionRootsForWorkspace

public DocumentModelList getSectionRootsForWorkspace(DocumentModel currentDoc,
                                                     boolean addDefaultSectionRoots)
                                              throws ClientException

Description copied from interface: RootSectionFinder

Returns the head (root) sections that are bound to a given Workspace.

If no specific binding is defined at the workspace level, an empty list is returned.

Specified by:

getSectionRootsForWorkspace in interface RootSectionFinder

Parameters:

currentDoc - the target Workspace

addDefaultSectionRoots - flag to indicate is default roots should be added

Returns:

Throws:

ClientException

getSectionRootsForWorkspace

public DocumentModelList getSectionRootsForWorkspace(DocumentModel currentDoc)
                                              throws ClientException

Description copied from interface: RootSectionFinder

Returns the head (root) sections that are bound to a given Workspace.

If no specific binding is defined at the workspace level, an empty list is returned.

Specified by:

getSectionRootsForWorkspace in interface RootSectionFinder

Parameters:

currentDoc - the target Workspace

Returns:

Throws:

ClientException

getDefaultSectionRoots

public DocumentModelList getDefaultSectionRoots(boolean onlyHeads,
                                                boolean addDefaultSectionRoots)
                                         throws ClientException

Specified by:

getDefaultSectionRoots in interface RootSectionFinder

Throws:

ClientException

getDefaultSectionRoots

public DocumentModelList getDefaultSectionRoots(boolean onlyHeads)
                                         throws ClientException

Specified by:

getDefaultSectionRoots in interface RootSectionFinder

Throws:

ClientException

run

public void run()
         throws ClientException

Description copied from class: UnrestrictedSessionRunner

This method will be called by UnrestrictedSessionRunner.runUnrestricted() with UnrestrictedSessionRunner.session available as an unrestricted session.

It can also be called directly in which case the UnrestrictedSessionRunner.session available will be the one passed to #UnrestrictedSessionRunner(CoreSession).

Specified by:

run in class UnrestrictedSessionRunner

Throws:

ClientException