IOptionStrategyDefinitionEnumerator.cs

/*
 * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
 * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.
*/
 
using System.Collections.Generic;
 
namespace QuantConnect.Securities.Option.StrategyMatcher
{
    /// <summary>
    /// Enumerates <see cref="OptionStrategyDefinition"/> for the purposes of providing a bias towards definitions
    /// that are more favorable to be matched before matching less favorable definitions.
    /// </summary>
    public interface IOptionStrategyDefinitionEnumerator
    {
        /// <summary>
        /// Enumerates the <paramref name="definitions"/> according to the implementation's own concept of favorability.
        /// </summary>
        IEnumerable<OptionStrategyDefinition> Enumerate(IReadOnlyList<OptionStrategyDefinition> definitions);
    }
}