PureMVC::IModel Class Reference

The interface definition for a PureMVC Model. More...

#include <pmvcpp.h>

Inheritance diagram for PureMVC::IModel:

[legend]

Collaboration diagram for PureMVC::IModel:

[legend]

List of all members.

Public Member Functions
virtual void	registerProxy (IProxy *proxy)=0
	Register an IProxy instance with the Model.
virtual IProxy *	retrieveProxy (std::string proxyName)=0
	Retrieve an IProxy instance from the Model.
virtual IProxy *	removeProxy (std::string proxyName)=0
	Remove an IProxy instance from the Model.
virtual bool	hasProxy (std::string proxyName)=0
	Check if a Proxy is registered.
virtual void	setMultitonKey (std::string key)=0
	Set multiton key.
virtual std::string	getMultitonKey ()=0
	Get multiton key.

---

Detailed Description

The interface definition for a PureMVC 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

---

Member Function Documentation

virtual std::string PureMVC::IMultitonKeyHeir::getMultitonKey

(

)

[pure virtual, inherited]

Get multiton key.

Returns the multiton key.

Returns:

The string key name

Implemented in PureMVC::MultitonKeyHeir.

virtual bool PureMVC::IModel::hasProxy

(

std::string

proxyName

)

[pure virtual]

Check if a Proxy is registered.

Parameters:

proxyName

Returns:

whether a Proxy is currently registered with the given proxyName.

Implemented in PureMVC::Model.

virtual void PureMVC::IModel::registerProxy

(

IProxy *

proxy

)

[pure virtual]

Register an IProxy instance with the Model.

Parameters:

	proxyName	the name to associate with this IProxy instance.
	proxy	an object reference to be held by the Model.

Implemented in PureMVC::Model.

virtual IProxy* PureMVC::IModel::removeProxy

(

std::string

proxyName

)

[pure virtual]

Remove an IProxy instance from the Model.

Parameters:

proxyName

name of the IProxy instance to be removed.

Returns:

the IProxy that was removed from the Model

Implemented in PureMVC::Model.

virtual IProxy* PureMVC::IModel::retrieveProxy

(

std::string

proxyName

)

[pure virtual]

Retrieve an IProxy instance from the Model.

Parameters:

proxyName

Returns:

the IProxy instance previously registered with the given proxyName.

Implemented in PureMVC::Model.

virtual void PureMVC::IMultitonKeyHeir::setMultitonKey

(

std::string

key

)

[pure virtual, inherited]

Set multiton key.

Sets the multiton key.

Parameters:

key

The name of the key

Implemented in PureMVC::MultitonKeyHeir.

---

The documentation for this class was generated from the following file:

• /Users/schell/Code/PureMVC-Plus-Plus/src/pmvcpp.h