PureMVC::IProxyRestricted Class Reference

The untemplated portion of the interface definition for a PureMVC Proxy. More...

#include <pmvcpp.h>

Inheritance diagram for PureMVC::IProxyRestricted:

Collaboration diagram for PureMVC::IProxyRestricted:

Public Member Functions
virtual std::string	getProxyName ()=0
	Get the Proxy name.
virtual void	onRegister ()=0
	Called by the Model when the Proxy is registered.
virtual void	onRemove ()=0
	Called by the Model when the Proxy is removed.
virtual void	sendNotification (int notificationName, Object *body, int notificationType)=0
	Send a `INotification`.
virtual void	sendNotification (int notificationName, int notificationType)=0
virtual void	sendNotification (int notificationName, Object *body)=0
virtual void	sendNotification (int notificationName)=0
virtual void	initializeNotifier (std::string key)=0
	Initialize this INotifier instance.

Detailed Description

The untemplated portion of the interface definition for a PureMVC Proxy.

Like IObserver and IMediator, IProxy has been split into two sections, the untemplated base and the templated derived class.

In PureMVC, IProxy implementors assume these responsibilities:

Additionally, IProxys typically:

Maintain references to one or more pieces of model data.
Provide methods for manipulating that data.
Generate INotifications when their model data changes.
Expose their name as a public static const called NAME, if they are not instantiated multiple times.
Encapsulate interaction with local or remote services used to fetch and persist model data.

virtual std::string PureMVC::IProxyRestricted::getProxyName ( ) [pure virtual]

Get the Proxy name.

virtual void PureMVC::INotifier::initializeNotifier ( std::string key ) [pure virtual, inherited]

Initialize this INotifier instance.

This is how a Notifier gets its multitonKey. Calls to sendNotification or to access the facade will fail until after this method has been called.

Parameters:

key

the multitonKey for this INotifier to use

virtual void PureMVC::IProxyRestricted::onRegister ( ) [pure virtual]

Called by the Model when the Proxy is registered.

virtual void PureMVC::IProxyRestricted::onRemove ( ) [pure virtual]

Called by the Model when the Proxy is removed.

virtual void PureMVC::INotifier::sendNotification	(	int	notificationName,
		Object *	body,
		int	notificationType
	)			`[pure virtual, inherited]`

Convenience method to prevent having to construct new notification instances in our implementation code.

Parameters:

	notificationName	the name of the notification to send
	body	the body of the notification (optional)
	type	the type of the notification (optional)

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