/Source/Bifrost/Events/IEventSubscriptionManager.cs

#region License

//

// Copyright (c) 2008-2012, DoLittle Studios and Komplett ASA

//

// Licensed under the Microsoft Permissive License (Ms-PL), Version 1.1 (the "License")

// With one exception :

//   Commercial libraries that is based partly or fully on Bifrost and is sold commercially,

//   must obtain a commercial license.

//

// You may not use this file except in compliance with the License.

// You may obtain a copy of the license at

//

//   http://bifrost.codeplex.com/license

//

// Unless required by applicable law or agreed to in writing, software

// distributed under the License is distributed on an "AS IS" BASIS,

// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

// See the License for the specific language governing permissions and

// limitations under the License.

//

#endregion

using System.Collections.Generic;



namespace Bifrost.Events

{

    /// <summary>

    /// Defines a manager for dealing with <see cref="EventSubscription">EventSubscriptions</see>

    /// </summary>

    public interface IEventSubscriptionManager

    {

        /// <summary>

        /// Get all <see cref="EventSubscription">EventSubscriptions</see>

        /// </summary>

        /// <returns>All available <see cref="EventSubscription">EventSubscriptions</see></returns>

        IEnumerable<EventSubscription> GetAllSubscriptions();



        /// <summary>

        /// Get all available <see cref="EventSubscription">EventSubscriptions</see>

        /// </summary>

        /// <returns>All available <see cref="EventSubscription">EventSubscriptions</see></returns>

        IEnumerable<EventSubscription> GetAvailableSubscriptions();



        /// <summary>

        /// Process a set of <see cref="IEvent">Events</see>

        /// </summary>

        /// <param name="events"><see cref="IEvent">Events</see> to process</param>

        void Process(IEnumerable<IEvent> events);



        /// <summary>

        /// Process a single <see cref="IEvent"/>

        /// </summary>

        /// <param name="event"><see cref="IEvent"/> to process</param>

        void Process(IEvent @event);

    }

}