PureMVC.Patterns.Proxy Class Reference

A base IProxy implementation. More...

Inheritance diagram for PureMVC.Patterns.Proxy:

PureMVC.Patterns.Notifier PureMVC.Interfaces.IProxy PureMVC.Interfaces.INotifier PureMVC.Interfaces.INotifier

List of all members.

Public Member Functions

 Proxy ()
 Proxy (string proxyName)
 Constructs a new proxy with the specified name and no data.
 Proxy (string proxyName, object data)
 Constructs a new proxy with the specified name and data.
virtual void OnRegister ()
 Called by the Model when the Proxy is registered.
virtual void OnRemove ()
 Called by the Model when the Proxy is removed.

Static Public Attributes

static string NAME = "Proxy"

Protected Attributes

string m_proxyName
object m_data
 The data object to be managed.

Properties

string ProxyName [get]
 Get the proxy name.
object Data [get, set]
 Set the data object.


Detailed Description

A base IProxy implementation.

In PureMVC, Proxy classes are used to manage parts of the application's data model

A Proxy might simply manage a reference to a local data object, in which case interacting with it might involve setting and getting of its data in synchronous fashion

Proxy classes are also used to encapsulate the application's interaction with remote services to save or retrieve data, in which case, we adopt an asyncronous idiom; setting data (or calling a method) on the Proxy and listening for a Notification to be sent when the Proxy has retrieved the data from the service

PureMVC.Core.Model


Constructor & Destructor Documentation

PureMVC.Patterns.Proxy.Proxy (  ) 

Constructs a new proxy with the default name and no data

PureMVC.Patterns.Proxy.Proxy ( string  proxyName  ) 

Constructs a new proxy with the specified name and no data.

Parameters:
proxyName The name of the proxy

PureMVC.Patterns.Proxy.Proxy ( string  proxyName,
object  data 
)

Constructs a new proxy with the specified name and data.

Parameters:
proxyName The name of the proxy
data The data to be managed


Member Function Documentation

virtual void PureMVC.Patterns.Proxy.OnRegister (  )  [virtual]

Called by the Model when the Proxy is registered.

Implements PureMVC.Interfaces.IProxy.

virtual void PureMVC.Patterns.Proxy.OnRemove (  )  [virtual]

Called by the Model when the Proxy is removed.

Implements PureMVC.Interfaces.IProxy.


Member Data Documentation

object PureMVC.Patterns.Proxy.m_data [protected]

The data object to be managed.

The name of the proxy

string PureMVC.Patterns.Proxy.NAME = "Proxy" [static]

The default proxy name


Property Documentation

object PureMVC.Patterns.Proxy.Data [get, set]

Set the data object.

Implements PureMVC.Interfaces.IProxy.

string PureMVC.Patterns.Proxy.ProxyName [get]

Get the proxy name.

Returns:

Implements PureMVC.Interfaces.IProxy.


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

Generated on Thu Jan 1 16:26:46 2009 for PureMVC by  doxygen 1.5.8