de.espirit.firstspirit.store

Interface WebeditStoreMappingPlugin

All Superinterfaces:

Plugin, Public

public interface WebeditStoreMappingPlugin
extends Plugin

This interface maps a given SiteStoreFolder to a (maybe new) PageFolder and is used during create and move operations in the FirstSpirit WebClient. It is necessary to allow different strategies in organizing content (page-store) and structure (site-stote).

Examples:

• Synchronous structure (default behaviour): maps to a folder with an equal hierarchy; keeps site- and page-store identical.
• One-folder-strategy: maps to a single page-store-folder; forces an editor to organize manually all new pages.
• Site-sections (example implementation): groups pages within folders named according to the first-level menu item.

Since:

5.0.206

Method Summary

Methods

Modifier and Type	Method and Description
PageFolder	requestMappedFolder(SiteStoreFolder folder) Returns the pagestore folder mapped to given folder or null if there is no mapped folder (so the WebClient isn't responsible for the page-store structure).
PageFolder	requireMappedFolder(SiteStoreFolder folder) Returns the pagestore folder mapped to given folder.

Methods inherited from interface de.espirit.firstspirit.client.plugin.Plugin

setUp, tearDown

Method Detail

requestMappedFolder

@Nullable
PageFolder requestMappedFolder(@NotNull
                                      SiteStoreFolder folder)

Returns the pagestore folder mapped to given folder or null if there is no mapped folder (so the WebClient isn't responsible for the page-store structure).

Called to check pre-conditions (e.g. before a move or rename operation) for further processing. Returning null means that the move/rename-operation won't have any effect to the page-store.

Parameters:

folder - The sitestore folder to retrieve pagestore folder for.

Returns:

The pagestore folder mapped to given folder or null if there is no folder mapped.

Since:

5.0.206

requireMappedFolder

@NotNull
PageFolder requireMappedFolder(@NotNull
                                     SiteStoreFolder folder)

Returns the pagestore folder mapped to given folder.
Called during create or move operations to determine in which folder the page should be created or moved into.

Parameters:

folder - The sitestore folder to retrieve pagestore folder for.

Returns:

The pagestore folder mapped to given folder.

Since:

5.0.206