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

FundBookmark More...

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

Public Types

enum class  EntryTypeEnum { ValuationPointFundCalendarEntry = 1 , BookmarkFundCalendarEntry = 2 }
 The type of the Fund Calendar Entry. Available values: ValuationPointFundCalendarEntry, BookmarkFundCalendarEntry. More...
 
- Public Types inherited from Lusid.Sdk.Model.FundCalendarEntries
enum class  FundCalendarEntriesTypeEnum { FinalisedValuationPoint = 1 , FundEstimateValuationPoint = 2 , FundBookmark = 3 }
 The type of the Calendar Entry. Available values: FinalisedValuationPoint, FundEstimateValuationPoint, FundBookmark. More...
 

Public Member Functions

 FundBookmark (string code=default(string), string displayName=default(string), string description=default(string), string navTypeCode=default(string), ResourceId timelineId=default(ResourceId), PreviousFundCalendarEntry previousEntry=default(PreviousFundCalendarEntry), DateTimeOffset effectiveAt=default(DateTimeOffset), DateTimeOffset asAt=default(DateTimeOffset), EntryTypeEnum entryType=default(EntryTypeEnum), string status=default(string), bool applyClearDown=default(bool), DateTimeOffset? holdingsAsAtOverride=default(DateTimeOffset?), DateTimeOffset? valuationsAsAtOverride=default(DateTimeOffset?), Dictionary< string, Property > properties=default(Dictionary< string, Property >), ModelVersion varVersion=default(ModelVersion), string href=default(string), string leaderNavTypeCode=default(string), FundCalendarEntriesTypeEnum fundCalendarEntriesType=default(FundCalendarEntriesTypeEnum))
 Initializes a new instance of the FundBookmark class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
override 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 (FundBookmark input)
 Returns true if FundBookmark instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
- Public Member Functions inherited from Lusid.Sdk.Model.FundCalendarEntries
 FundCalendarEntries (FundCalendarEntriesTypeEnum fundCalendarEntriesType=default(FundCalendarEntriesTypeEnum))
 Initializes a new instance of the FundCalendarEntries class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
override bool Equals (object input)
 Returns true if objects are equal More...
 
bool Equals (FundCalendarEntries input)
 Returns true if FundCalendarEntries instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 FundBookmark ()
 Initializes a new instance of the FundBookmark class. More...
 
IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > BaseValidate (ValidationContext validationContext)
 To validate all properties of the instance More...
 
- Protected Member Functions inherited from Lusid.Sdk.Model.FundCalendarEntries
 FundCalendarEntries ()
 Initializes a new instance of the FundCalendarEntries class. More...
 
IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > BaseValidate (ValidationContext validationContext)
 To validate all properties of the instance More...
 

Properties

EntryTypeEnum EntryType [get, set]
 The type of the Fund Calendar Entry. Available values: ValuationPointFundCalendarEntry, BookmarkFundCalendarEntry. More...
 
string Code [get, set]
 The unique Code of the Calendar Entry. The Calendar Entry, together with the Fund Scope and Code, uniquely identifies a Fund Calendar Entry. More...
 
string DisplayName [get, set]
 The name of the Fund Calendar entry. More...
 
string Description [get, set]
 A description for the Fund Calendar entry. More...
 
string NavTypeCode [get, set]
 The navTypeCode of the Fund Calendar Entry. This is the code of the NAV type that this Calendar Entry is associated with. More...
 
ResourceId TimelineId [get, set]
 Gets or Sets TimelineId More...
 
PreviousFundCalendarEntry PreviousEntry [get, set]
 Gets or Sets PreviousEntry More...
 
DateTimeOffset EffectiveAt [get, set]
 The effective at of the Calendar Entry. More...
 
DateTimeOffset AsAt [get, set]
 The asAt datetime for the Calendar Entry. More...
 
string Status [get, set]
 The status of the Fund Calendar Entry. Can be &#39;Estimate&#39;, &#39;Unofficial&#39; or &#39;Final&#39;. More...
 
bool ApplyClearDown [get, set]
 Set to true if that closed period should have the clear down applied. More...
 
DateTimeOffset? HoldingsAsAtOverride [get, set]
 The optional AsAt Override to use for building holdings in the Valuation Point. Defaults to QueryAsAt. More...
 
DateTimeOffset? ValuationsAsAtOverride [get, set]
 The optional AsAt Override to use for performing valuations in the Valuation Point. Defaults to QueryAsAt. More...
 
Dictionary< string, PropertyProperties [get, set]
 The properties for the Calendar Entry. These will be from the &#39;ClosedPeriod&#39; domain. More...
 
ModelVersion VarVersion [get, set]
 Gets or Sets VarVersion More...
 
string Href [get, set]
 The specific Uniform Resource Identifier (URI) for this resource at the requested asAt datetime. More...
 
string LeaderNavTypeCode [get, set]
 The code of the Nav Type that this Nav Type will follow when set. More...
 
- Properties inherited from Lusid.Sdk.Model.FundCalendarEntries
FundCalendarEntriesTypeEnum FundCalendarEntriesType [get, set]
 The type of the Calendar Entry. Available values: FinalisedValuationPoint, FundEstimateValuationPoint, FundBookmark. More...
 

Detailed Description

FundBookmark

Member Enumeration Documentation

◆ EntryTypeEnum

The type of the Fund Calendar Entry. Available values: ValuationPointFundCalendarEntry, BookmarkFundCalendarEntry.

The type of the Fund Calendar Entry. Available values: ValuationPointFundCalendarEntry, BookmarkFundCalendarEntry.

Enumerator
ValuationPointFundCalendarEntry 

Enum ValuationPointFundCalendarEntry for value: ValuationPointFundCalendarEntry

BookmarkFundCalendarEntry 

Enum BookmarkFundCalendarEntry for value: BookmarkFundCalendarEntry

Constructor & Destructor Documentation

◆ FundBookmark() [1/2]

Lusid.Sdk.Model.FundBookmark.FundBookmark ( )
inlineprotected

Initializes a new instance of the FundBookmark class.

◆ FundBookmark() [2/2]

Lusid.Sdk.Model.FundBookmark.FundBookmark ( string  code = default(string),
string  displayName = default(string),
string  description = default(string),
string  navTypeCode = default(string),
ResourceId  timelineId = default(ResourceId),
PreviousFundCalendarEntry  previousEntry = default(PreviousFundCalendarEntry),
DateTimeOffset  effectiveAt = default(DateTimeOffset),
DateTimeOffset  asAt = default(DateTimeOffset),
EntryTypeEnum  entryType = default(EntryTypeEnum),
string  status = default(string),
bool  applyClearDown = default(bool),
DateTimeOffset?  holdingsAsAtOverride = default(DateTimeOffset?),
DateTimeOffset?  valuationsAsAtOverride = default(DateTimeOffset?),
Dictionary< string, Property properties = default(Dictionary<string, Property>),
ModelVersion  varVersion = default(ModelVersion),
string  href = default(string),
string  leaderNavTypeCode = default(string),
FundCalendarEntriesTypeEnum  fundCalendarEntriesType = default(FundCalendarEntriesTypeEnum) 
)
inline

Initializes a new instance of the FundBookmark class.

Parameters
codeThe unique Code of the Calendar Entry. The Calendar Entry, together with the Fund Scope and Code, uniquely identifies a Fund Calendar Entry. (required).
displayNameThe name of the Fund Calendar entry. (required).
descriptionA description for the Fund Calendar entry..
navTypeCodeThe navTypeCode of the Fund Calendar Entry. This is the code of the NAV type that this Calendar Entry is associated with. (required).
timelineIdtimelineId.
previousEntrypreviousEntry.
effectiveAtThe effective at of the Calendar Entry..
asAtThe asAt datetime for the Calendar Entry. (required).
entryTypeThe type of the Fund Calendar Entry. Available values: ValuationPointFundCalendarEntry, BookmarkFundCalendarEntry. (required).
statusThe status of the Fund Calendar Entry. Can be &#39;Estimate&#39;, &#39;Unofficial&#39; or &#39;Final&#39;..
applyClearDownSet to true if that closed period should have the clear down applied..
holdingsAsAtOverrideThe optional AsAt Override to use for building holdings in the Valuation Point. Defaults to QueryAsAt..
valuationsAsAtOverrideThe optional AsAt Override to use for performing valuations in the Valuation Point. Defaults to QueryAsAt..
propertiesThe properties for the Calendar Entry. These will be from the &#39;ClosedPeriod&#39; domain..
varVersionvarVersion (required).
hrefThe specific Uniform Resource Identifier (URI) for this resource at the requested asAt datetime..
leaderNavTypeCodeThe code of the Nav Type that this Nav Type will follow when set..
fundCalendarEntriesTypeThe type of the Calendar Entry. Available values: FinalisedValuationPoint, FundEstimateValuationPoint, FundBookmark. (required) (default to "FundBookmark").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.FundBookmark.BaseValidate ( ValidationContext  validationContext)
inlineprotected

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if FundBookmark instances are equal

Parameters
inputInstance of FundBookmark to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

override string Lusid.Sdk.Model.FundBookmark.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.FundCalendarEntries.

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ ApplyClearDown

bool Lusid.Sdk.Model.FundBookmark.ApplyClearDown
getset

Set to true if that closed period should have the clear down applied.

Set to true if that closed period should have the clear down applied.

◆ AsAt

DateTimeOffset Lusid.Sdk.Model.FundBookmark.AsAt
getset

The asAt datetime for the Calendar Entry.

The asAt datetime for the Calendar Entry.

◆ Code

string Lusid.Sdk.Model.FundBookmark.Code
getset

The unique Code of the Calendar Entry. The Calendar Entry, together with the Fund Scope and Code, uniquely identifies a Fund Calendar Entry.

The unique Code of the Calendar Entry. The Calendar Entry, together with the Fund Scope and Code, uniquely identifies a Fund Calendar Entry.

◆ Description

string Lusid.Sdk.Model.FundBookmark.Description
getset

A description for the Fund Calendar entry.

A description for the Fund Calendar entry.

◆ DisplayName

string Lusid.Sdk.Model.FundBookmark.DisplayName
getset

The name of the Fund Calendar entry.

The name of the Fund Calendar entry.

◆ EffectiveAt

DateTimeOffset Lusid.Sdk.Model.FundBookmark.EffectiveAt
getset

The effective at of the Calendar Entry.

The effective at of the Calendar Entry.

◆ EntryType

EntryTypeEnum Lusid.Sdk.Model.FundBookmark.EntryType
getset

The type of the Fund Calendar Entry. Available values: ValuationPointFundCalendarEntry, BookmarkFundCalendarEntry.

The type of the Fund Calendar Entry. Available values: ValuationPointFundCalendarEntry, BookmarkFundCalendarEntry.

◆ HoldingsAsAtOverride

DateTimeOffset? Lusid.Sdk.Model.FundBookmark.HoldingsAsAtOverride
getset

The optional AsAt Override to use for building holdings in the Valuation Point. Defaults to QueryAsAt.

The optional AsAt Override to use for building holdings in the Valuation Point. Defaults to QueryAsAt.

◆ Href

string Lusid.Sdk.Model.FundBookmark.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.

◆ LeaderNavTypeCode

string Lusid.Sdk.Model.FundBookmark.LeaderNavTypeCode
getset

The code of the Nav Type that this Nav Type will follow when set.

The code of the Nav Type that this Nav Type will follow when set.

◆ NavTypeCode

string Lusid.Sdk.Model.FundBookmark.NavTypeCode
getset

The navTypeCode of the Fund Calendar Entry. This is the code of the NAV type that this Calendar Entry is associated with.

The navTypeCode of the Fund Calendar Entry. This is the code of the NAV type that this Calendar Entry is associated with.

◆ PreviousEntry

PreviousFundCalendarEntry Lusid.Sdk.Model.FundBookmark.PreviousEntry
getset

Gets or Sets PreviousEntry

◆ Properties

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

The properties for the Calendar Entry. These will be from the &#39;ClosedPeriod&#39; domain.

The properties for the Calendar Entry. These will be from the &#39;ClosedPeriod&#39; domain.

◆ Status

string Lusid.Sdk.Model.FundBookmark.Status
getset

The status of the Fund Calendar Entry. Can be &#39;Estimate&#39;, &#39;Unofficial&#39; or &#39;Final&#39;.

The status of the Fund Calendar Entry. Can be &#39;Estimate&#39;, &#39;Unofficial&#39; or &#39;Final&#39;.

◆ TimelineId

ResourceId Lusid.Sdk.Model.FundBookmark.TimelineId
getset

Gets or Sets TimelineId

◆ ValuationsAsAtOverride

DateTimeOffset? Lusid.Sdk.Model.FundBookmark.ValuationsAsAtOverride
getset

The optional AsAt Override to use for performing valuations in the Valuation Point. Defaults to QueryAsAt.

The optional AsAt Override to use for performing valuations in the Valuation Point. Defaults to QueryAsAt.

◆ VarVersion

ModelVersion Lusid.Sdk.Model.FundBookmark.VarVersion
getset

Gets or Sets VarVersion


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