Namespace: PureMVC.Interfaces.IFacade

Interface IFacade

All Superinterfaces:

INotifier

All Known Implementing Classes:

TFacade

public interface IFacade ( INotifier

Persistent

False

see

remarks

The Facade Pattern suggests providing a single class to act as a certal point of communication for subsystemsIn PureMVC, the Facade acts as an interface between the core MVC actors (Model, View, Controller) and the rest of your application

summary

The interface definition for a PureMVC Facade

Method Summary
public function Boolean	HasCommand(NotificationName: string) Check if a Command is registered for a given Notification
public function Boolean	HasMediator(MediatorName: string) Check if a Mediator is registered or not
public function Boolean	HasProxy(ProxyName: string) Check if a Proxy is registered
public Sub	NotifyObservers(Note: PureMVC.Interfaces.INotification.INotification ) 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.
public Sub	RegisterCommand(NotificationName: string; CommandType: TClass) Register an ICommand with the Controller
public Sub	RegisterMediator(Mediator: PureMVC.Interfaces.IMediator.IMediator ) Register an IMediator instance with the View
public Sub	RegisterProxy(Proxy: PureMVC.Interfaces.IProxy.IProxy ) Register an IProxy with the Model by name
public Sub	RemoveCommand(NotificationName: string) Remove a previously registered ICommand to INotification mapping from the Controller.
public function PureMVC.Interfaces.IMediator.IMediator	RemoveMediator(MediatorName: string) Remove a IMediator instance from the View
public function PureMVC.Interfaces.IMediator.IMediator	RemoveMediator(Mediator: PureMVC.Interfaces.IMediator.IMediator )
public function PureMVC.Interfaces.IProxy.IProxy	RemoveProxy(ProxyName: string) Remove an IProxy instance from the Model by name
public function PureMVC.Interfaces.IMediator.IMediator	RetrieveMediator(MediatorName: string) Retrieve an IMediator instance from the View
public function PureMVC.Interfaces.IProxy.IProxy	RetrieveProxy(ProxyName: string) Retrieve a IProxy from the Model by name

 

Method Detail

HasCommand

public function HasCommand(NotificationName: string): Boolean

Reintroduce

False

Returns

Boolean

summary

Check if a Command is registered for a given Notification

returns

whether a Command is currently registered for the given notificationName.

param

The name of the INotification to check.

public function HasMediator(MediatorName: string): Boolean

Reintroduce

False

Returns

Boolean

summary

Check if a Mediator is registered or not

returns

whether a Mediator is registered with the given mediatorName.

param

The name of the IMediator instance to check

public function HasProxy(ProxyName: string): Boolean

Reintroduce

False

Returns

Boolean

summary

Check if a Proxy is registered

returns

whether a Proxy is currently registered with the given proxyName.

param

The name of the IProxy instance to check

public procedure NotifyObservers(Note: PureMVC.Interfaces.INotification.INotification )

Reintroduce

False

summary

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.

param

the INotification to notify IObservers of.

public procedure RegisterCommand(NotificationName: string; CommandType: TClass)

Reintroduce

False

summary

Register an ICommand with the Controller

param

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

public procedure RegisterMediator(Mediator: PureMVC.Interfaces.IMediator.IMediator )

Reintroduce

False

summary

Register an IMediator instance with the View

param

A reference to the IMediator instance

public procedure RegisterProxy(Proxy: PureMVC.Interfaces.IProxy.IProxy )

Reintroduce

False

summary

Register an IProxy with the Model by name

param

The IProxy to be registered with the Model

public procedure RemoveCommand(NotificationName: string)

Reintroduce

False

summary

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

param

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

public function RemoveMediator(MediatorName: string): PureMVC.Interfaces.IMediator.IMediator 

Reintroduce

False

Returns

IMediator

summary

Remove a IMediator instance from the View

param

The name of the IMediator instance to be removed

public function RemoveMediator(Mediator: PureMVC.Interfaces.IMediator.IMediator ): PureMVC.Interfaces.IMediator.IMediator 

Reintroduce

False

Returns

IMediator

public function RemoveProxy(ProxyName: string): PureMVC.Interfaces.IProxy.IProxy 

Reintroduce

False

Returns

IProxy

summary

Remove an IProxy instance from the Model by name

param

The IProxy to remove from the Model

public function RetrieveMediator(MediatorName: string): PureMVC.Interfaces.IMediator.IMediator 

Reintroduce

False

Returns

IMediator

summary

Retrieve an IMediator instance from the View

returns

The IMediator previously registered with the given mediatorName

param

The name of the IMediator instance to retrieve

public function RetrieveProxy(ProxyName: string): PureMVC.Interfaces.IProxy.IProxy 

Reintroduce

False

Returns

IProxy

summary

Retrieve a IProxy from the Model by name

returns

The IProxy previously regisetered by proxyName with the Model

param

The name of the IProxy instance to be retrieved

Generalization Link

to Interface INotifier

Client

IFacade

Supplier

INotifier