org.broadleafcommerce.cms.page.dao

Interface PageDao

All Known Implementing Classes:

PageDaoImpl

public interface PageDao

Created by bpolster.

Method Summary

Modifier and Type	Method and Description
Page	addPage(Page clonedPage)
void	delete(Page page)
void	detachPage(Page page)
List<Page>	findPageByURI(Locale fullLocale, Locale languageOnlyLocale, String uri)
List<Page>	findPageByURI(Locale locale, String uri)
List<Page>	findPageByURI(String uri)
List<Page>	findPageByURIAndActiveDate(String uri, Date activeDate) Returns pages that match the given URI and are within 1 day of the active date (potentially cached).
Long	getCurrentDateResolution()
List<Page>	readAllPages() Returns all pages, regardless of any sandbox they are apart of
List<PageTemplate>	readAllPageTemplates() Returns all page templates, regardless of any sandbox they are apart of
List<Page>	readOnlineAndIncludedPages(int limit, int offset, String sortBy) Retrieve a subset of all online and site map included Pages
Page	readPageById(Long id)
List<PageField>	readPageFieldsByPageId(Long pageId)
PageTemplate	readPageTemplateById(Long id)
PageTemplate	savePageTemplate(PageTemplate template) Saves the given PageTemplate
void	setCurrentDateResolution(Long currentDateResolution)
Page	updatePage(Page page)

Method Detail

readPageById

Page readPageById(Long id)

readPageFieldsByPageId

List<PageField> readPageFieldsByPageId(Long pageId)

readPageTemplateById

PageTemplate readPageTemplateById(Long id)

savePageTemplate

PageTemplate savePageTemplate(PageTemplate template)

Saves the given PageTemplate

Parameters:

template - the PageTemplate to save

Returns:

the database-saved PageTemplate

updatePage

Page updatePage(Page page)

delete

void delete(Page page)

addPage

Page addPage(Page clonedPage)

readAllPages

List<Page> readAllPages()

Returns all pages, regardless of any sandbox they are apart of

Returns:

all Pages configured in the system

readOnlineAndIncludedPages

@Nonnull
List<Page> readOnlineAndIncludedPages(@Nonnull
                                               int limit,
                                               @Nonnull
                                               int offset,
                                               @Nonnull
                                               String sortBy)

Retrieve a subset of all online and site map included Pages

Parameters:

limit - the maximum number of results

offset - the starting point in the record set

sortBy - the column to sort by

Returns:

readAllPageTemplates

List<PageTemplate> readAllPageTemplates()

Returns all page templates, regardless of any sandbox they are apart of

Returns:

all PageTemplates configured in the system

findPageByURI

List<Page> findPageByURI(String uri)

findPageByURI

List<Page> findPageByURI(Locale fullLocale,
                         Locale languageOnlyLocale,
                         String uri)

findPageByURI

List<Page> findPageByURI(Locale locale,
                         String uri)

findPageByURIAndActiveDate

List<Page> findPageByURIAndActiveDate(String uri,
                                      Date activeDate)

Returns pages that match the given URI and are within 1 day of the active date (potentially cached). This will only cache for 1 day.

Parameters:

uri -

activeDate -

Returns:

detachPage

void detachPage(Page page)

getCurrentDateResolution

Long getCurrentDateResolution()

setCurrentDateResolution

void setCurrentDateResolution(Long currentDateResolution)