/*
* QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
* Lean Algorithmic Trading Engine v2.0. Copyright 2023 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;
using System.Linq;
using Python.Runtime;
using Newtonsoft.Json;
using System.Collections.Generic;
using QuantConnect.Data.UniverseSelection;
namespace QuantConnect.Data.Fundamental
{
///
/// The accession number is a unique number that EDGAR assigns to each submission as the submission is received.
///
public class FinancialStatementsAccessionNumber : MultiPeriodField
{
///
/// The default period
///
protected override string DefaultPeriod => "OneMonth";
///
/// Gets/sets the OneMonth period value for the field
///
[JsonProperty("1M")]
public string OneMonth => FundamentalService.Get(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AccessionNumber_OneMonth);
///
/// Gets/sets the TwoMonths period value for the field
///
[JsonProperty("2M")]
public string TwoMonths => FundamentalService.Get(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AccessionNumber_TwoMonths);
///
/// Gets/sets the ThreeMonths period value for the field
///
[JsonProperty("3M")]
public string ThreeMonths => FundamentalService.Get(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AccessionNumber_ThreeMonths);
///
/// Gets/sets the SixMonths period value for the field
///
[JsonProperty("6M")]
public string SixMonths => FundamentalService.Get(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AccessionNumber_SixMonths);
///
/// Gets/sets the NineMonths period value for the field
///
[JsonProperty("9M")]
public string NineMonths => FundamentalService.Get(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AccessionNumber_NineMonths);
///
/// Returns true if the field contains a value for the default period
///
public override bool HasValue => !BaseFundamentalDataProvider.IsNone(typeof(string), FundamentalService.Get(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AccessionNumber_OneMonth));
///
/// Returns the default value for the field
///
public override string Value
{
get
{
var defaultValue = FundamentalService.Get(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AccessionNumber_OneMonth);
if (!BaseFundamentalDataProvider.IsNone(typeof(string), defaultValue))
{
return defaultValue;
}
return base.Value;
}
}
///
/// Gets a dictionary of period names and values for the field
///
/// The dictionary of period names and values
public override IReadOnlyDictionary GetPeriodValues()
{
var result = new Dictionary();
foreach (var kvp in new[] { new Tuple("1M", OneMonth), new Tuple("2M", TwoMonths), new Tuple("3M", ThreeMonths), new Tuple("6M", SixMonths), new Tuple("9M", NineMonths) })
{
if (!BaseFundamentalDataProvider.IsNone(typeof(string), kvp.Item2))
{
result[kvp.Item1] = kvp.Item2;
}
}
return result;
}
///
/// Gets the value of the field for the requested period
///
/// The requested period
/// The value for the period
public override string GetPeriodValue(string period) => FundamentalService.Get(TimeProvider.GetUtcNow(), SecurityIdentifier, Enum.Parse($"FinancialStatements_AccessionNumber_{ConvertPeriod(period)}"));
///
/// Creates a new empty instance
///
public FinancialStatementsAccessionNumber()
{
}
///
/// Creates a new instance for the given time and security
///
public FinancialStatementsAccessionNumber(ITimeProvider timeProvider, SecurityIdentifier securityIdentifier) : base(timeProvider, securityIdentifier)
{
}
}
}