org.puremvc.java.multicore.interfaces
Interface INotifier

All Known Subinterfaces:
ICommand, IFacade, IMediator, IProxy
All Known Implementing Classes:
Facade, MacroCommand, Mediator, Proxy, SimpleCommand

public interface INotifier

The interface definition for a PureMVC Notifier.

MacroCommand, Command, Mediator and Proxy all have a need to send Notifications.

The INotifier interface provides a common method called sendNotification that relieves implementation code of the necessity to actually construct Notifications.

The Notifier class, which all of the above mentioned classes extend, also provides an initialized reference to the Facade Singleton, which is required for the convienience method for sending Notifications, but also eases implementation as these classes have frequent Facade interactions and usually require access to the facade anyway.

See Also:
IFacade, INotification

Method Summary
 void initializeNotifier(String key)
          Initialize this INotifier instance.
 void sendNotification(String notificationName)
          Send a INotification.
 void sendNotification(String notificationName, Object body)
          Send a INotification.
 void sendNotification(String notificationName, Object body, String type)
          Send a INotification.
 

Method Detail

sendNotification

void sendNotification(String notificationName,
                      Object body,
                      String type)
Send a INotification.

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)

sendNotification

void sendNotification(String notificationName,
                      Object body)
Send a INotification.

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)

sendNotification

void sendNotification(String notificationName)
Send a INotification.

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

Parameters:
notificationName - the name of the notification to send

initializeNotifier

void initializeNotifier(String key)
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


Copyright © 2010. All Rights Reserved.