org.nuxeo.ecm.platform.publisher.helper

Interface RootSectionFinder

All Known Implementing Classes:

AbstractRootSectionsFinder, DefaultRootSectionsFinder

public interface RootSectionFinder

Method Summary

Methods

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()

Method Detail

reset

void reset()

getSectionRootsForWorkspace

DocumentModelList getSectionRootsForWorkspace(DocumentModel currentDoc,
                                            boolean addDefaultSectionRoots)
                                              throws ClientException

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.

Parameters:

currentDoc - the target Workspace

addDefaultSectionRoots - flag to indicate is default roots should be added

Returns:

Throws:

ClientException

getSectionRootsForWorkspace

DocumentModelList getSectionRootsForWorkspace(DocumentModel currentDoc)
                                              throws ClientException

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.

Parameters:

currentDoc - the target Workspace

Returns:

Throws:

ClientException

getAccessibleSectionRoots

DocumentModelList getAccessibleSectionRoots(DocumentModel currentDoc)
                                            throws ClientException

Throws:

ClientException

getDefaultSectionRoots

DocumentModelList getDefaultSectionRoots(boolean onlyHeads,
                                       boolean addDefaultSectionRoots)
                                         throws ClientException

Throws:

ClientException

getDefaultSectionRoots

DocumentModelList getDefaultSectionRoots(boolean onlyHeads)
                                         throws ClientException

Throws:

ClientException