LUSID C# SDK
Public Member Functions | Properties | List of all members
Lusid.Sdk.Model.ClosedPeriod Class Reference

ClosedPeriod More...

Inheritance diagram for Lusid.Sdk.Model.ClosedPeriod:
Inheritance graph
[legend]

Public Member Functions

 ClosedPeriod (string closedPeriodId=default(string), string displayName=default(string), string description=default(string), DateTimeOffset effectiveStart=default(DateTimeOffset), DateTimeOffset effectiveEnd=default(DateTimeOffset), DateTimeOffset asAtClosed=default(DateTimeOffset), Dictionary< string, Property > properties=default(Dictionary< string, Property >), ModelVersion varVersion=default(ModelVersion), List< PostCloseActivity > postCloseActivities=default(List< PostCloseActivity >), DateTimeOffset? holdingsAsAtClosedOverride=default(DateTimeOffset?), DateTimeOffset? valuationAsAtClosedOverride=default(DateTimeOffset?), string branchStatus=default(string), string href=default(string), List< Link > links=default(List< Link >))
 Initializes a new instance of the ClosedPeriod class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
virtual string ToJson ()
 Returns the JSON string presentation of the object More...
 
override bool Equals (object input)
 Returns true if objects are equal More...
 
bool Equals (ClosedPeriod input)
 Returns true if ClosedPeriod instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Properties

string ClosedPeriodId [get, set]
 The unique Id of the Closed Period. The ClosedPeriodId, together with the Timeline Scope and Code, uniquely identifies a Closed Period More...
 
string DisplayName [get, set]
 The name of the Closed Period. More...
 
string Description [get, set]
 A description for the Closed Period. More...
 
DateTimeOffset EffectiveStart [get, set]
 The effective start of the Closed Period More...
 
DateTimeOffset EffectiveEnd [get, set]
 The effective end of the Closed Period More...
 
DateTimeOffset AsAtClosed [get, set]
 The asAt closed datetime for the Closed Period More...
 
Dictionary< string, PropertyProperties [get, set]
 The Closed Periods properties. These will be from the &#39;ClosedPeriod&#39; domain. More...
 
ModelVersion VarVersion [get, set]
 Gets or Sets VarVersion More...
 
List< PostCloseActivityPostCloseActivities [get, set]
 All the post close activities for the closed period. More...
 
DateTimeOffset? HoldingsAsAtClosedOverride [get, set]
 The optional AsAtClosed Override to use for building holdings in the Closed Period.If not specified, the AsAtClosed on the Closed Period will be used. More...
 
DateTimeOffset? ValuationAsAtClosedOverride [get, set]
 The optional AsAtClosed Override to use for performing valuations in the Closed Period.If not specified, the AsAtClosed on the Closed Period will be used. More...
 
string BranchStatus [get, set]
 The branch status of the closed period, e.g. Confirmed/Unconfirmed. More...
 
string Href [get, set]
 The specific Uniform Resource Identifier (URI) for this resource at the requested asAt datetime. More...
 
List< LinkLinks [get, set]
 Gets or Sets Links More...
 

Detailed Description

ClosedPeriod

Constructor & Destructor Documentation

◆ ClosedPeriod()

Lusid.Sdk.Model.ClosedPeriod.ClosedPeriod ( string  closedPeriodId = default(string),
string  displayName = default(string),
string  description = default(string),
DateTimeOffset  effectiveStart = default(DateTimeOffset),
DateTimeOffset  effectiveEnd = default(DateTimeOffset),
DateTimeOffset  asAtClosed = default(DateTimeOffset),
Dictionary< string, Property properties = default(Dictionary<string, Property>),
ModelVersion  varVersion = default(ModelVersion),
List< PostCloseActivity postCloseActivities = default(List<PostCloseActivity>),
DateTimeOffset?  holdingsAsAtClosedOverride = default(DateTimeOffset?),
DateTimeOffset?  valuationAsAtClosedOverride = default(DateTimeOffset?),
string  branchStatus = default(string),
string  href = default(string),
List< Link links = default(List<Link>) 
)
inline

Initializes a new instance of the ClosedPeriod class.

Parameters
closedPeriodIdThe unique Id of the Closed Period. The ClosedPeriodId, together with the Timeline Scope and Code, uniquely identifies a Closed Period.
displayNameThe name of the Closed Period..
descriptionA description for the Closed Period..
effectiveStartThe effective start of the Closed Period.
effectiveEndThe effective end of the Closed Period.
asAtClosedThe asAt closed datetime for the Closed Period.
propertiesThe Closed Periods properties. These will be from the &#39;ClosedPeriod&#39; domain..
varVersionvarVersion.
postCloseActivitiesAll the post close activities for the closed period..
holdingsAsAtClosedOverrideThe optional AsAtClosed Override to use for building holdings in the Closed Period.If not specified, the AsAtClosed on the Closed Period will be used..
valuationAsAtClosedOverrideThe optional AsAtClosed Override to use for performing valuations in the Closed Period.If not specified, the AsAtClosed on the Closed Period will be used..
branchStatusThe branch status of the closed period, e.g. Confirmed/Unconfirmed..
hrefThe specific Uniform Resource Identifier (URI) for this resource at the requested asAt datetime..
linkslinks.

Member Function Documentation

◆ Equals() [1/2]

bool Lusid.Sdk.Model.ClosedPeriod.Equals ( ClosedPeriod  input)
inline

Returns true if ClosedPeriod instances are equal

Parameters
inputInstance of ClosedPeriod to be compared
Returns
Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.ClosedPeriod.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.ClosedPeriod.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.ClosedPeriod.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.ClosedPeriod.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AsAtClosed

DateTimeOffset Lusid.Sdk.Model.ClosedPeriod.AsAtClosed
getset

The asAt closed datetime for the Closed Period

The asAt closed datetime for the Closed Period

◆ BranchStatus

string Lusid.Sdk.Model.ClosedPeriod.BranchStatus
getset

The branch status of the closed period, e.g. Confirmed/Unconfirmed.

The branch status of the closed period, e.g. Confirmed/Unconfirmed.

◆ ClosedPeriodId

string Lusid.Sdk.Model.ClosedPeriod.ClosedPeriodId
getset

The unique Id of the Closed Period. The ClosedPeriodId, together with the Timeline Scope and Code, uniquely identifies a Closed Period

The unique Id of the Closed Period. The ClosedPeriodId, together with the Timeline Scope and Code, uniquely identifies a Closed Period

◆ Description

string Lusid.Sdk.Model.ClosedPeriod.Description
getset

A description for the Closed Period.

A description for the Closed Period.

◆ DisplayName

string Lusid.Sdk.Model.ClosedPeriod.DisplayName
getset

The name of the Closed Period.

The name of the Closed Period.

◆ EffectiveEnd

DateTimeOffset Lusid.Sdk.Model.ClosedPeriod.EffectiveEnd
getset

The effective end of the Closed Period

The effective end of the Closed Period

◆ EffectiveStart

DateTimeOffset Lusid.Sdk.Model.ClosedPeriod.EffectiveStart
getset

The effective start of the Closed Period

The effective start of the Closed Period

◆ HoldingsAsAtClosedOverride

DateTimeOffset? Lusid.Sdk.Model.ClosedPeriod.HoldingsAsAtClosedOverride
getset

The optional AsAtClosed Override to use for building holdings in the Closed Period.If not specified, the AsAtClosed on the Closed Period will be used.

The optional AsAtClosed Override to use for building holdings in the Closed Period.If not specified, the AsAtClosed on the Closed Period will be used.

◆ Href

string Lusid.Sdk.Model.ClosedPeriod.Href
getset

The specific Uniform Resource Identifier (URI) for this resource at the requested asAt datetime.

The specific Uniform Resource Identifier (URI) for this resource at the requested asAt datetime.

◆ Links

List<Link> Lusid.Sdk.Model.ClosedPeriod.Links
getset

Gets or Sets Links

◆ PostCloseActivities

List<PostCloseActivity> Lusid.Sdk.Model.ClosedPeriod.PostCloseActivities
getset

All the post close activities for the closed period.

All the post close activities for the closed period.

◆ Properties

Dictionary<string, Property> Lusid.Sdk.Model.ClosedPeriod.Properties
getset

The Closed Periods properties. These will be from the &#39;ClosedPeriod&#39; domain.

The Closed Periods properties. These will be from the &#39;ClosedPeriod&#39; domain.

◆ ValuationAsAtClosedOverride

DateTimeOffset? Lusid.Sdk.Model.ClosedPeriod.ValuationAsAtClosedOverride
getset

The optional AsAtClosed Override to use for performing valuations in the Closed Period.If not specified, the AsAtClosed on the Closed Period will be used.

The optional AsAtClosed Override to use for performing valuations in the Closed Period.If not specified, the AsAtClosed on the Closed Period will be used.

◆ VarVersion

ModelVersion Lusid.Sdk.Model.ClosedPeriod.VarVersion
getset

Gets or Sets VarVersion


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