com.sage.swt.client.ui.builder
Interface UIDefinitionCache

All Known Implementing Classes:

GlobalCache

public interface UIDefinitionCache

Interface for a cache of built UI definitions, which are keyed by their associated URL key (conceptually, the download URL).

Method Summary

void	addUIDefinition(URLKey uiDefURLKey, DefaultUIDefinition uiDefinition) Adds a UI definition and its associated URL key to the cache.
boolean	containsUIDefintion(URLKey uiDefURLKey) Indicates whether or not the cache contains a UI definition with the specified URL key.
DefaultUIDefinition	getUIDefinition(URLKey uiDefURLKey) Gets the UI definition associated with the specified URL key, or null if there is no such entry in the cache.

Method Detail

containsUIDefintion

boolean containsUIDefintion(URLKey uiDefURLKey)

Indicates whether or not the cache contains a UI definition with the specified URL key.

Parameters:

uiDefURLKey - The UI definition's URL key (which is created using the contract path and declarative definition name).

Returns:

Whether or not the cache contains a UI definition with the specified URL key.

getUIDefinition

DefaultUIDefinition getUIDefinition(URLKey uiDefURLKey)

Gets the UI definition associated with the specified URL key, or null if there is no such entry in the cache.

Parameters:

uiDefURLKey - The UI definition's URL key (which is created using the contract path and declarative definition name).

Returns:

The UI definition associated with the specified URL key, or null if there is no such entry in the cache.

addUIDefinition

void addUIDefinition(URLKey uiDefURLKey,
                     DefaultUIDefinition uiDefinition)

Adds a UI definition and its associated URL key to the cache. Duplicates and nulls are ignored.

Parameters:

uiDefURLKey - The UI definition's URL key (which is created using the contract path and declarative definition name).

uiDefinition - The built UI definition.