com.sap.tc.webdynpro.progmodel.model.api
Interface IWDModelRegistry

All Known Subinterfaces:

IWDDynamicRFCModel

public interface IWDModelRegistry

Registry for managing Model classes by Key. Provides a registry for model classes as well as a finder service for model class instances.

Version:

$Id: //tc/WebDynproRuntime/630_VAL_REL/src/_webdynpro_progmodel/java/com/sap/tc/webdynpro/progmodel/model/api/IWDModelRegistry.java#1 $

Method Summary

com.sap.tc.cmi.model.ICMIModelClass	lookup(java.lang.Object key, java.lang.String extent) Lookups the ModelClass Instance with the key given in the extent If an instance already exists under this key/extent, the old value is replaced and returned, otherwise null is returned.
com.sap.tc.cmi.model.ICMIModelClass	register(java.lang.Object key, java.lang.String extent, com.sap.tc.cmi.model.ICMIModelClass instance) Registers the ModelClass Instance with the key given If an instance already exists under this key, the old value is replaced and returned, otherwise null is returned.
com.sap.tc.cmi.model.ICMIModelClass	unregister(java.lang.Object key, java.lang.String extent) Unregisters the Instance registered under the key given and returns the previously registered instance (or null if no instance was registered)
void	unregisterAll() unregisters all ModelClass Instances registered with this model

Method Detail

register

public com.sap.tc.cmi.model.ICMIModelClass register(java.lang.Object key,
                                                    java.lang.String extent,
                                                    com.sap.tc.cmi.model.ICMIModelClass instance)

Registers the ModelClass Instance with the key given If an instance already exists under this key, the old value is replaced and returned, otherwise null is returned.

Parameters:

key - key with which the ModelClass instance is to be registered.

extent - name of extent or collection within which to unregister the instance associated with this key

instance - ModelClass instance to be registered.

Returns:

previous value associated with specified key, or null if there was no mapping for key.

unregister

public com.sap.tc.cmi.model.ICMIModelClass unregister(java.lang.Object key,
                                                      java.lang.String extent)

Unregisters the Instance registered under the key given and returns the previously registered instance (or null if no instance was registered)

Parameters:

key - key to be unregistered.

extent - name of extent or collection within which to unregister the instance associated with this key

Returns:

ModelClass instance previously registered with the specified key, or null if no object was registered.

lookup

public com.sap.tc.cmi.model.ICMIModelClass lookup(java.lang.Object key,
                                                  java.lang.String extent)

Lookups the ModelClass Instance with the key given in the extent If an instance already exists under this key/extent, the old value is replaced and returned, otherwise null is returned.

Parameters:

key - key with which the ModelClass instance is to be registered.

extent - name of extent or collection within which to unregister the instance associated with this key

instance - ModelClass instance to be registered.

Returns:

previous value associated with specified key, or null if there was no mapping for key.

unregisterAll

public void unregisterAll()

unregisters all ModelClass Instances registered with this model