com.foreach.across.modules.webcms.domain.page.services

Interface WebCmsPageService

public interface WebCmsPageService

API for managing WebCmsPage instances.

Since:

0.0.1

Author:

Arne Vandamme

Method Summary

Modifier and Type	Method and Description
Optional<WebCmsPage>	findByCanonicalPath(String canonicalPath) Find a single page by its unique canonical path.
Optional<WebCmsPage>	findByCanonicalPathAndDomain(String canonicalPath, WebCmsDomain domain) Find a single page by its canonicalPath within the specified domain.
WebCmsPageType	getPageType(String objectId) Get the WebCmsPageType with the specified object id.
WebCmsPageType	getPageTypeByKey(String typeKey) Get the WebCmsPageType with the specified type key, attached to the current domain.
WebCmsPageType	getPageTypeByKey(String typeKey, WebCmsDomain domain) Get the WebCmsPageType with the specified type key, attached to the specified domain.
Map<ModificationType,ModificationReport<PrepareModificationType,Object>>	prepareForSaving(WebCmsPage page) Prepares a WebCmsPage for saving.

Method Detail

getPageType

WebCmsPageType getPageType(String objectId)

Get the WebCmsPageType with the specified object id.

Parameters:

objectId - the page type should have

Returns:

page type or null

getPageTypeByKey

WebCmsPageType getPageTypeByKey(String typeKey)

Get the WebCmsPageType with the specified type key, attached to the current domain. Will take the multi-domain configuration into account when looking for the page type: will also inspect no-domain if allowed for WebCmsPageType.

Parameters:

typeKey - the page type should have

Returns:

page type or null if not found

getPageTypeByKey

WebCmsPageType getPageTypeByKey(String typeKey,
                                WebCmsDomain domain)

Get the WebCmsPageType with the specified type key, attached to the specified domain. Will take the multi-domain configuration into account when looking for the page type: will also inspect no-domain if allowed for WebCmsPageType.

Parameters:

typeKey - the page type should have

domain - the page type is requested for

Returns:

page type or null if not found

findByCanonicalPath

Optional<WebCmsPage> findByCanonicalPath(String canonicalPath)

Find a single page by its unique canonical path. This method will use findByCanonicalPathAndDomain(java.lang.String, com.foreach.across.modules.webcms.domain.domain.WebCmsDomain) to retrieve the page. The domain used in looking up the page will be retrieved from the WebCmsMultiDomainService

Parameters:

canonicalPath - unique path

Returns:

page if found

findByCanonicalPathAndDomain

Optional<WebCmsPage> findByCanonicalPathAndDomain(String canonicalPath,
                                                  WebCmsDomain domain)

Find a single page by its canonicalPath within the specified domain.

Parameters:

canonicalPath - the unique path within the domain

domain - the domain

Returns:

page if found

prepareForSaving

Map<ModificationType,ModificationReport<PrepareModificationType,Object>> prepareForSaving(WebCmsPage page)

Prepares a WebCmsPage for saving. This will check the different settings on the page, and will generate the fields that need generating. The instance passed as a parameter will be updated with the new values. If the new values are different, a ModificationReport will be returned for the action taken.

Note: this method does not perform actual validation on the properties.

Parameters:

page - to update

Returns:

map of possible modifications that have been performed