com.cognifide.slice.cq

Interface PageChildrenProvider

All Known Implementing Classes:

PageChildrenProviderImpl

public interface PageChildrenProvider

Provides methods for accessing child pages.

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getChildPages(String path, com.day.cq.commons.Filter<com.day.cq.wcm.api.Page> filter, RecursiveMode recurseMode) Returns child pages of a page under specified path.
List<String>	getChildPages(String path, RecursiveMode recurseMode) Returns child pages of a page under specified path.

Method Detail

getChildPages

List<String> getChildPages(String path,
                         com.day.cq.commons.Filter<com.day.cq.wcm.api.Page> filter,
                         RecursiveMode recurseMode)

Returns child pages of a page under specified path. If a page under specified path doesn't exist, empty list is returned. The result list is filtered using specified filter.

Parameters:

path - page path

filter - filter to limit the result list

recurseMode - defines if pages should be read recursively or only direct children should be returned

Returns:

filtered list of child pages

getChildPages

List<String> getChildPages(String path,
                         RecursiveMode recurseMode)

Returns child pages of a page under specified path. If a page under specified path doesn't exist, empty list is returned.

Parameters:

path - page path

recurseMode - defines if pages should be read recursively or only direct children should be returned

Returns:

filtered list of child pages