Lean  $LEAN_TAG$
QuantConnect.Data.Fundamental.AuditorReportStatus Class Reference

Auditor opinion code will be one of the following for each annual period: Code Meaning UQ Unqualified Opinion UE Unqualified Opinion with Explanation QM Qualified - Due to change in accounting method QL Qualified - Due to litigation OT Qualified Opinion - Other AO Adverse Opinion DS Disclaim an opinion UA Unaudited More...

Inheritance diagram for QuantConnect.Data.Fundamental.AuditorReportStatus:
[legend]

Public Member Functions

override IReadOnlyDictionary< string, string > GetPeriodValues ()
 Gets a dictionary of period names and values for the field More...
 
override string GetPeriodValue (string period)
 Gets the value of the field for the requested period More...
 
 AuditorReportStatus ()
 Creates a new empty instance More...
 
 AuditorReportStatus (ITimeProvider timeProvider, SecurityIdentifier securityIdentifier)
 Creates a new instance for the given time and security More...
 
- Public Member Functions inherited from QuantConnect.Data.Fundamental.MultiPeriodField< string >
virtual bool HasPeriodValue (string period)
 Returns true if the field contains a value for the requested period More...
 
IEnumerable< string > GetPeriodNames ()
 Gets the list of available period names for the field More...
 
bool HasValues ()
 Returns true if the field has at least one value for one period More...
 
override string ToString ()
 Returns a string that represents the current object. More...
 

Public Attributes

string OneMonth => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_OneMonth)
 Gets/sets the OneMonth period value for the field More...
 
string TwoMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_TwoMonths)
 Gets/sets the TwoMonths period value for the field More...
 
string ThreeMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_ThreeMonths)
 Gets/sets the ThreeMonths period value for the field More...
 
string SixMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_SixMonths)
 Gets/sets the SixMonths period value for the field More...
 
string NineMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_NineMonths)
 Gets/sets the NineMonths period value for the field More...
 
string TwelveMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_TwelveMonths)
 Gets/sets the TwelveMonths period value for the field More...
 
override bool HasValue => !BaseFundamentalDataProvider.IsNone(typeof(string), FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_TwelveMonths))
 Returns true if the field contains a value for the default period More...
 
- Public Attributes inherited from QuantConnect.Data.Fundamental.MultiPeriodField< string >
virtual T Value
 Returns the default value for the field More...
 

Protected Attributes

override string DefaultPeriod => "TwelveMonths"
 The default period More...
 

Properties

override string Value [get]
 Returns the default value for the field More...
 
- Properties inherited from QuantConnect.Data.Fundamental.MultiPeriodField< string >
static T NoValue [get]
 No Value More...
 
ITimeProvider TimeProvider [get]
 The time provider instance to use More...
 
abstract string DefaultPeriod [get]
 The default period More...
 
SecurityIdentifier SecurityIdentifier [get, set]
 The target security identifier More...
 
abstract bool HasValue [get]
 Returns true if the field contains a value for the default period More...
 

Additional Inherited Members

- Static Public Member Functions inherited from QuantConnect.Data.Fundamental.MultiPeriodField< string >
static implicit operator T (MultiPeriodField< T > instance)
 Returns the default value for the field More...
 
static implicit operator decimal (MultiPeriodField instance)
 Returns the default value for the field More...
 
- Protected Member Functions inherited from QuantConnect.Data.Fundamental.MultiPeriodField< string >
 MultiPeriodField ()
 Creates an empty instance More...
 
 MultiPeriodField (ITimeProvider timeProvider, SecurityIdentifier securityIdentifier)
 Creates a new instance More...
 
 MultiPeriodField ()
 Creates an empty instance More...
 
 MultiPeriodField (ITimeProvider timeProvider, SecurityIdentifier securityIdentifier)
 Creates a new instance More...
 
string ConvertPeriod (string period)
 Returns a string that represents the current object. More...
 

Detailed Description

Auditor opinion code will be one of the following for each annual period: Code Meaning UQ Unqualified Opinion UE Unqualified Opinion with Explanation QM Qualified - Due to change in accounting method QL Qualified - Due to litigation OT Qualified Opinion - Other AO Adverse Opinion DS Disclaim an opinion UA Unaudited

Definition at line 29 of file AuditorReportStatus.cs.

Constructor & Destructor Documentation

◆ AuditorReportStatus() [1/2]

QuantConnect.Data.Fundamental.AuditorReportStatus.AuditorReportStatus ( )

Creates a new empty instance

Definition at line 120 of file AuditorReportStatus.cs.

◆ AuditorReportStatus() [2/2]

QuantConnect.Data.Fundamental.AuditorReportStatus.AuditorReportStatus ( ITimeProvider  timeProvider,
SecurityIdentifier  securityIdentifier 
)

Creates a new instance for the given time and security

Definition at line 127 of file AuditorReportStatus.cs.

Member Function Documentation

◆ GetPeriodValues()

override IReadOnlyDictionary<string, string> QuantConnect.Data.Fundamental.AuditorReportStatus.GetPeriodValues ( )
virtual

Gets a dictionary of period names and values for the field

Returns
The dictionary of period names and values

Implements QuantConnect.Data.Fundamental.MultiPeriodField< string >.

Definition at line 97 of file AuditorReportStatus.cs.

Here is the call graph for this function:

◆ GetPeriodValue()

override string QuantConnect.Data.Fundamental.AuditorReportStatus.GetPeriodValue ( string  period)
virtual

Gets the value of the field for the requested period

Parameters
periodThe requested period
Returns
The value for the period

Implements QuantConnect.Data.Fundamental.MultiPeriodField< string >.

Member Data Documentation

◆ DefaultPeriod

override string QuantConnect.Data.Fundamental.AuditorReportStatus.DefaultPeriod => "TwelveMonths"
protected

The default period

Definition at line 34 of file AuditorReportStatus.cs.

◆ OneMonth

string QuantConnect.Data.Fundamental.AuditorReportStatus.OneMonth => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_OneMonth)

Gets/sets the OneMonth period value for the field

Definition at line 40 of file AuditorReportStatus.cs.

◆ TwoMonths

string QuantConnect.Data.Fundamental.AuditorReportStatus.TwoMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_TwoMonths)

Gets/sets the TwoMonths period value for the field

Definition at line 46 of file AuditorReportStatus.cs.

◆ ThreeMonths

string QuantConnect.Data.Fundamental.AuditorReportStatus.ThreeMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_ThreeMonths)

Gets/sets the ThreeMonths period value for the field

Definition at line 52 of file AuditorReportStatus.cs.

◆ SixMonths

string QuantConnect.Data.Fundamental.AuditorReportStatus.SixMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_SixMonths)

Gets/sets the SixMonths period value for the field

Definition at line 58 of file AuditorReportStatus.cs.

◆ NineMonths

string QuantConnect.Data.Fundamental.AuditorReportStatus.NineMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_NineMonths)

Gets/sets the NineMonths period value for the field

Definition at line 64 of file AuditorReportStatus.cs.

◆ TwelveMonths

string QuantConnect.Data.Fundamental.AuditorReportStatus.TwelveMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_TwelveMonths)

Gets/sets the TwelveMonths period value for the field

Definition at line 70 of file AuditorReportStatus.cs.

◆ HasValue

override bool QuantConnect.Data.Fundamental.AuditorReportStatus.HasValue => !BaseFundamentalDataProvider.IsNone(typeof(string), FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_TwelveMonths))

Returns true if the field contains a value for the default period

Definition at line 75 of file AuditorReportStatus.cs.

Property Documentation

◆ Value

override string QuantConnect.Data.Fundamental.AuditorReportStatus.Value
get

Returns the default value for the field

Definition at line 81 of file AuditorReportStatus.cs.


The documentation for this class was generated from the following file: