include/PureMVC/Interfaces/IController.hpp

Go to the documentation of this file.

//  IController.hpp
//  PureMVC_C++
//
//  PureMVC Port to C++ by Tang Khai Phuong <phuong.tang@puremvc.org>
//  PureMVC - Copyright(c) 2006-2011 Futurescale, Inc., Some rights reserved.
//  Your reuse is governed by the Creative Commons Attribution 3.0 License
//

#if !defined(__PUREMVC_INTERFACES_ICONTROLLER_HPP__)
#define __PUREMVC_INTERFACES_ICONTROLLER_HPP__

// STL include
#include <string>
// PureMVC include
#if !defined(__PUREMVC_HPP__)
#define __PUREMVC_INCLUDE__
#include "../PureMVC.hpp"
#endif /* __PUREMVC_HPP__ */

#include "INotification.hpp"
#include "ICommand.hpp"
#include "IAggregate.hpp"

namespace PureMVC
{
    namespace Interfaces
    {
        struct PUREMVC_API IController
        {
            typedef std::auto_ptr<IAggregate<std::string> > NotificationNames;

            virtual void registerCommand(std::string const& notification_name, ICommand* command) = 0;

            virtual void executeCommand(INotification const& notification) = 0;

            virtual ICommand const& retrieveCommand(std::string const& notification_name) const = 0;

            virtual ICommand& retrieveCommand(std::string const& notification_name) = 0;

            virtual ICommand* removeCommand(std::string const& notification_name) = 0;

            virtual bool hasCommand(std::string const& notification_name) const = 0;

            virtual NotificationNames listNotificationNames(void) const = 0;

            virtual ~IController(void);
        };
    }
}

#endif /* __PUREMVC_INTERFACES_ICONTROLLER_HPP__ */