/Source/Bifrost/Sagas/IChapter.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

namespace Bifrost.Sagas

{

	/// <summary>

	/// Defines a chapter in a <see cref="ISaga"/>

	/// </summary>

    public interface IChapter

	{

        /// <summary>

        /// Lifecycle method for a <see cref="IChapter"/>, gets called when the <see cref="IChapter"/> is created

        /// </summary>

	    void OnCreated();



        /// <summary>

        /// Lifecycle method for a <see cref="IChapter"/>, gets called when the <see cref="IChapter"/> is set as current

        /// </summary>

	    void OnSetCurrent();



        /// <summary>

        /// Lifecycle method for a <see cref="IChapter"/>, gets called when the <see cref="IChapter"/> is transitioned to

        /// </summary>

	    void OnTransitionedTo();

	}

}