org.opencms.ade.sitemap.shared
Interface I_CmsSitemapController

public interface I_CmsSitemapController

The interface to the sitemap controller.

This interface allows classes which are shared between client and server to access client-only functionality without statically depending on client-only code.

Since:

8.0.0

Method Summary

java.util.Map<java.lang.String,CmsClientProperty>	getPropertiesForId(CmsUUID id) Gets the property map for the given id.
void	registerEntry(CmsClientSitemapEntry entry) Registers the given entry within the data model.
void	registerPathChange(CmsClientSitemapEntry entry, java.lang.String oldPath) Registers the change of the sitepath with the given controller.
java.util.Map<java.lang.String,CmsClientProperty>	replaceProperties(CmsUUID id, java.util.Map<java.lang.String,CmsClientProperty> properties) This method is used to establish a unique property map object for each id, but replaces the contents of the map object with new values for each call.

Method Detail

getPropertiesForId

java.util.Map<java.lang.String,CmsClientProperty> getPropertiesForId(CmsUUID id)

Gets the property map for the given id.

Parameters:

id - a structure id

Returns:

the property map for that structure id

registerEntry

void registerEntry(CmsClientSitemapEntry entry)

Registers the given entry within the data model.

Parameters:

entry - the entry to register

registerPathChange

void registerPathChange(CmsClientSitemapEntry entry,
                        java.lang.String oldPath)

Registers the change of the sitepath with the given controller.

Parameters:

entry - the sitemap entry

oldPath - the old path

replaceProperties

java.util.Map<java.lang.String,CmsClientProperty> replaceProperties(CmsUUID id,
                                                                    java.util.Map<java.lang.String,CmsClientProperty> properties)

This method is used to establish a unique property map object for each id, but replaces the contents of the map object with new values for each call.

The first call to the method with a given id will just return the map passed in. The n-th call to the method with a given id will return the map object passed in with the first method call for that id, but with its contents replaced by the contents of the map passed in with the n-th call for that id.

The purpose of this is to avoid multiple redundant copies of the same logical map of properties being stored in multiple places.

Parameters:

id - the map identifying the resource to which the properties belong

properties - the new properties for the given id

Returns:

the original properties object for the given id, but with its contents replaced