PureMVC.Interfaces.IFacade Interface Reference

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

Inheritance diagram for PureMVC.Interfaces.IFacade:

List of all members.

Public Member Functions

void RegisterProxy (IProxy proxy)

IProxy RetrieveProxy (string proxyName)

Retrieve a IProxy from the Model by name.

IProxy RemoveProxy (string proxyName)

Remove an IProxy instance from the Model by name.

bool HasProxy (string proxyName)

Check if a Proxy is registered.

void RegisterCommand (string notificationName, Type commandType)

void RemoveCommand (string notificationName)

Remove a previously registered ICommand to INotification mapping from the Controller.

bool HasCommand (string notificationName)

Check if a Command is registered for a given Notification.

void RegisterMediator (IMediator mediator)

IMediator RetrieveMediator (string mediatorName)

Retrieve an IMediator instance from the View.

IMediator RemoveMediator (string mediatorName)

Remove a IMediator instance from the View.

bool HasMediator (string mediatorName)

Check if a Mediator is registered or not.

void NotifyObservers (INotification note)

Notify the IObservers for a particular INotification.
All previously attached IObservers for this INotification's list are notified and are passed a reference to the INotification in the order in which they were registered.
NOTE: Use this method only if you are sending custom Notifications. Otherwise use the sendNotification method which does not require you to create the Notification instance.
.

Detailed Description

The interface definition for a PureMVC Facade.

The Facade Pattern suggests providing a single class to act as a certal point of communication for subsystems

In PureMVC, the Facade acts as an interface between the core MVC actors (Model, View, Controller) and the rest of your application

PureMVC.Interfaces.IModel PureMVC.Interfaces.IView PureMVC.Interfaces.IController PureMVC.Interfaces.ICommand PureMVC.Interfaces.INotification

Member Function Documentation

bool PureMVC.Interfaces.IFacade.HasCommand ( string notificationName )

Check if a Command is registered for a given Notification.

Parameters:

notificationName The name of the INotification to check.

Returns:: whether a Command is currently registered for the given notificationName.

Implemented in PureMVC.Patterns.Facade.

bool PureMVC.Interfaces.IFacade.HasMediator ( string mediatorName )

Check if a Mediator is registered or not.

Parameters:

mediatorName The name of the IMediator instance to check

Returns:: whether a Mediator is registered with the given mediatorName.

Implemented in PureMVC.Patterns.Facade.

bool PureMVC.Interfaces.IFacade.HasProxy ( string proxyName )

Check if a Proxy is registered.

Parameters:

proxyName The name of the IProxy instance to check

Returns:: whether a Proxy is currently registered with the given proxyName.

Implemented in PureMVC.Patterns.Facade.

void PureMVC.Interfaces.IFacade.NotifyObservers ( INotification note )

Notify the IObservers for a particular INotification.

All previously attached IObservers for this INotification's list are notified and are passed a reference to the INotification in the order in which they were registered.

NOTE: Use this method only if you are sending custom Notifications. Otherwise use the sendNotification method which does not require you to create the Notification instance.

.

Parameters:

note the INotification to notify IObservers of.

Implemented in PureMVC.Patterns.Facade.

void PureMVC.Interfaces.IFacade.RegisterCommand	(	string	notificationName,
		Type	commandType
	)

Register an ICommand with the Controller

Parameters:

	notificationName	The name of the `INotification` to associate the `ICommand` with.
	commandType	A reference to the `Type` of the `ICommand`

Implemented in PureMVC.Patterns.Facade.

void PureMVC.Interfaces.IFacade.RegisterMediator ( IMediator mediator )

Register an IMediator instance with the View

Parameters:

mediator A reference to the IMediator instance

Implemented in PureMVC.Patterns.Facade.

void PureMVC.Interfaces.IFacade.RegisterProxy ( IProxy proxy )

Register an IProxy with the Model by name

Parameters:

proxy The IProxy to be registered with the Model

Implemented in PureMVC.Patterns.Facade.

void PureMVC.Interfaces.IFacade.RemoveCommand ( string notificationName )

Remove a previously registered ICommand to INotification mapping from the Controller.

Parameters:

notificationName TRemove a previously registered ICommand to INotification mapping from the Controller.

Implemented in PureMVC.Patterns.Facade.

IMediator PureMVC.Interfaces.IFacade.RemoveMediator ( string mediatorName )

Remove a IMediator instance from the View.

Parameters:

mediatorName The name of the IMediator instance to be removed

Implemented in PureMVC.Patterns.Facade.

IProxy PureMVC.Interfaces.IFacade.RemoveProxy ( string proxyName )

Remove an IProxy instance from the Model by name.

Parameters:

proxyName The IProxy to remove from the Model

Implemented in PureMVC.Patterns.Facade.

IMediator PureMVC.Interfaces.IFacade.RetrieveMediator ( string mediatorName )

Retrieve an IMediator instance from the View.

Parameters:

mediatorName The name of the IMediator instance to retrieve

Returns:: The IMediator previously registered with the given mediatorName

Implemented in PureMVC.Patterns.Facade.

IProxy PureMVC.Interfaces.IFacade.RetrieveProxy ( string proxyName )

Retrieve a IProxy from the Model by name.

Parameters:

proxyName The name of the IProxy instance to be retrieved

Returns:: The IProxy previously regisetered by proxyName with the Model

Implemented in PureMVC.Patterns.Facade.

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

PureMVC/Interfaces/IFacade.cs


Public Member Functions
void	RegisterProxy (IProxy proxy)
IProxy	RetrieveProxy (string proxyName)
	Retrieve a `IProxy` from the `Model` by name.
IProxy	RemoveProxy (string proxyName)
	Remove an `IProxy` instance from the `Model` by name.
bool	HasProxy (string proxyName)
	Check if a Proxy is registered.
void	RegisterCommand (string notificationName, Type commandType)
void	RemoveCommand (string notificationName)
	Remove a previously registered `ICommand` to `INotification` mapping from the Controller.
bool	HasCommand (string notificationName)
	Check if a Command is registered for a given Notification.
void	RegisterMediator (IMediator mediator)
IMediator	RetrieveMediator (string mediatorName)
	Retrieve an `IMediator` instance from the `View`.
IMediator	RemoveMediator (string mediatorName)
	Remove a `IMediator` instance from the `View`.
bool	HasMediator (string mediatorName)
	Check if a Mediator is registered or not.
void	NotifyObservers (INotification note)
	Notify the `IObservers` for a particular `INotification`. All previously attached `IObservers` for this `INotification`'s list are notified and are passed a reference to the `INotification` in the order in which they were registered. NOTE: Use this method only if you are sending custom Notifications. Otherwise use the sendNotification method which does not require you to create the Notification instance. .