com.hybris.cockpitng.util

Interface CockpitZulCache

All Superinterfaces:

Resettable

All Known Implementing Classes:

DefaultCockpitZulCache

public interface CockpitZulCache
extends Resettable

Cache for PageDefinitions. Used by CockpitUIFactory to cache e.g. widget view definitions.

Method Summary

Modifier and Type	Method and Description
org.zkoss.zk.ui.metainfo.PageDefinition	addPageDefinitionToCache(String path, org.zkoss.zk.ui.metainfo.PageDefinition def) Adds a PageDefinition to the cache.
Set<String>	getDefinitionPaths() Returns all paths currently stored in the cache.
org.zkoss.zk.ui.metainfo.PageDefinition	getPageDefinition(String path) Returns the PageDefinition for a given path.
void	reset() Clears all entries in the cache.

Method Detail

getPageDefinition

org.zkoss.zk.ui.metainfo.PageDefinition getPageDefinition(String path)

Returns the PageDefinition for a given path.

Parameters:

path - An unique identifier for the page.

Returns:

A PageDefinition, if present in the cache, or null otherwise.

addPageDefinitionToCache

org.zkoss.zk.ui.metainfo.PageDefinition addPageDefinitionToCache(String path,
                                                                 org.zkoss.zk.ui.metainfo.PageDefinition def)

Adds a PageDefinition to the cache.

Parameters:

path - The path to the zul file.

def - The PageDefinition to add to the cache.

Returns:

The PageDefinition that was added (for convenience).

getDefinitionPaths

Set<String> getDefinitionPaths()

Returns all paths currently stored in the cache.

reset

void reset()

Clears all entries in the cache.

Specified by:

reset in interface Resettable