IModel Interface / puremvc Library / Dart Documentation

IModel Interface

The interface definition for a PureMVC MultiCore Model.

In PureMVC, IModel implementors provide access to IProxy objects by named lookup.

An IModel assumes these responsibilities:

Maintain a cache of IProxy instances.
Provide methods for registering, retrieving, and removing IProxy instances.

Your application must register IProxy instances with the IModel. Typically, you use an ICommand to create and register IProxy instances once the IFacade has initialized the core actors.

See IProxy, IFacade

Implemented by

Model

Methods

Code bool hasProxy(String proxyName) #

Check if an IProxy is registered with the IModel.

Param proxyName - the name of the IProxy instance you're looking for.
Returns bool - whether an IProxy is currently registered with the given proxyName.

bool hasProxy( String proxyName );

Code String get multitonKey() #

String get multitonKey();

Code void set multitonKey(String key) #

This IModel's Multiton Key

void set multitonKey( String key );

Code void registerProxy(IProxy proxy) #

Param proxy - an object reference to be held by the IModel.

void registerProxy( IProxy proxy );

Code IProxy removeProxy(String proxyName) #

Remove an IProxy instance from the IModel.

Param proxyName - name of the IProxy instance to be removed.
Returns IProxy - the IProxy that was removed from the IModel.

IProxy removeProxy( String proxyName );

Code IProxy retrieveProxy(String proxyName) #

Retrieve an IProxy instance from the IModel.

Param proxyName - the name of the IProxy instance to retrieve.
Returns the IProxy instance previously registered with the given proxyName.

IProxy retrieveProxy( String proxyName );