Lusid.Sdk.Model.DiaryEntry Class Reference

DiaryEntry More...

Inheritance diagram for Lusid.Sdk.Model.DiaryEntry:

Public Member Functions
	DiaryEntry (string href=default(string), ResourceId aborId=default(ResourceId), string diaryEntryCode=default(string), string type=default(string), string name=default(string), string status=default(string), bool applyClearDown=default(bool), DateTimeOffset effectiveAt=default(DateTimeOffset), DateTimeOffset queryAsAt=default(DateTimeOffset), DateTimeOffset previousEntryTime=default(DateTimeOffset), Dictionary< string, Property > properties=default(Dictionary< string, Property >), ModelVersion varVersion=default(ModelVersion), List< Link > links=default(List< Link >))
	Initializes a new instance of the DiaryEntry 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 (DiaryEntry input)
	Returns true if DiaryEntry instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	DiaryEntry ()
	Initializes a new instance of the DiaryEntry class. More...

Properties
string	Href [get, set]
	The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime. More...
ResourceId	AborId [get, set]
	Gets or Sets AborId More...
string	DiaryEntryCode [get, set]
	The code of the diary entry. More...
string	Type [get, set]
	The type of the diary entry. Available values: PeriodBoundary, ValuationPoint, Other. More...
string	Name [get, set]
	The name of the diary entry. More...
string	Status [get, set]
	The status of the diary entry. Statuses are constrained and defaulted by 'Type' specified. Type 'Other' defaults to 'Undefined' and supports 'Undefined', 'Estimate', 'Candidate', and 'Final'. Type 'PeriodBoundary' defaults to 'Estimate' when closing a period, and supports 'Estimate' and 'Final' for closing periods and 'Final' for locking periods. Type 'ValuationPoint' defaults to 'Estimate' when upserting a diary entry, moves to 'Candidate' or 'Final' when a ValuationPoint is accepted, and 'Final' when it is finalised. Available values: Undefined, Estimate, Final, Candidate, Unofficial. More...
bool	ApplyClearDown [get, set]
	Defaults to false. Set to true if you want that the closed period to have the clear down applied. Available values: Undefined, Estimate, Final, Candidate, Unofficial. More...
DateTimeOffset	EffectiveAt [get, set]
	The effective time of the diary entry. More...
DateTimeOffset	QueryAsAt [get, set]
	The query time of the diary entry. Defaults to latest. More...
DateTimeOffset	PreviousEntryTime [get, set]
	The entry time of the previous diary entry. More...
Dictionary< string, Property >	Properties [get, set]
	A set of properties for the diary entry. More...
ModelVersion	VarVersion [get, set]
	Gets or Sets VarVersion More...
List< Link >	Links [get, set]
	Gets or Sets Links More...

Detailed Description

DiaryEntry

Constructor & Destructor Documentation

DiaryEntry() [1/2]

Lusid.Sdk.Model.DiaryEntry.DiaryEntry ( )

inlineprotected

Initializes a new instance of the DiaryEntry class.

DiaryEntry() [2/2]

Lusid.Sdk.Model.DiaryEntry.DiaryEntry ( string  href = default(string), ResourceId  aborId = default(ResourceId), string  diaryEntryCode = default(string), string  type = default(string), string  name = default(string), string  status = default(string), bool  applyClearDown = default(bool), DateTimeOffset  effectiveAt = default(DateTimeOffset), DateTimeOffset  queryAsAt = default(DateTimeOffset), DateTimeOffset  previousEntryTime = default(DateTimeOffset), Dictionary< string, Property >  properties = default(Dictionary<string, Property>), ModelVersion  varVersion = default(ModelVersion), List< Link >  links = default(List<Link>)  )

inline

Initializes a new instance of the DiaryEntry class.

Parameters

href	The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime..
aborId	aborId.
diaryEntryCode	The code of the diary entry..
type	The type of the diary entry. Available values: PeriodBoundary, ValuationPoint, Other. (required).
name	The name of the diary entry..
status	The status of the diary entry. Statuses are constrained and defaulted by 'Type' specified. Type 'Other' defaults to 'Undefined' and supports 'Undefined', 'Estimate', 'Candidate', and 'Final'. Type 'PeriodBoundary' defaults to 'Estimate' when closing a period, and supports 'Estimate' and 'Final' for closing periods and 'Final' for locking periods. Type 'ValuationPoint' defaults to 'Estimate' when upserting a diary entry, moves to 'Candidate' or 'Final' when a ValuationPoint is accepted, and 'Final' when it is finalised. Available values: Undefined, Estimate, Final, Candidate, Unofficial. (required).
applyClearDown	Defaults to false. Set to true if you want that the closed period to have the clear down applied. Available values: Undefined, Estimate, Final, Candidate, Unofficial..
effectiveAt	The effective time of the diary entry. (required).
queryAsAt	The query time of the diary entry. Defaults to latest..
previousEntryTime	The entry time of the previous diary entry..
properties	A set of properties for the diary entry..
varVersion	varVersion.
links	links.

Member Function Documentation

Equals() [1/2]

bool Lusid.Sdk.Model.DiaryEntry.Equals ( DiaryEntry  input )

inline

Returns true if DiaryEntry instances are equal

Parameters

input

Instance of DiaryEntry to be compared

Returns

Boolean

Equals() [2/2]

override bool Lusid.Sdk.Model.DiaryEntry.Equals ( object  input )

inline

Returns true if objects are equal

Parameters

input

Object to be compared

Returns

Boolean

GetHashCode()

override int Lusid.Sdk.Model.DiaryEntry.GetHashCode ( )

inline

Gets the hash code

Returns

Hash code

ToJson()

virtual string Lusid.Sdk.Model.DiaryEntry.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

override string Lusid.Sdk.Model.DiaryEntry.ToString ( )

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

AborId

ResourceId Lusid.Sdk.Model.DiaryEntry.AborId

getset

Gets or Sets AborId

ApplyClearDown

bool Lusid.Sdk.Model.DiaryEntry.ApplyClearDown

getset

Defaults to false. Set to true if you want that the closed period to have the clear down applied. Available values: Undefined, Estimate, Final, Candidate, Unofficial.

Defaults to false. Set to true if you want that the closed period to have the clear down applied. Available values: Undefined, Estimate, Final, Candidate, Unofficial.

DiaryEntryCode

string Lusid.Sdk.Model.DiaryEntry.DiaryEntryCode

getset

The code of the diary entry.

The code of the diary entry.

EffectiveAt

DateTimeOffset Lusid.Sdk.Model.DiaryEntry.EffectiveAt

getset

The effective time of the diary entry.

The effective time of the diary entry.

Href

string Lusid.Sdk.Model.DiaryEntry.Href

getset

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

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

Links

List<Link> Lusid.Sdk.Model.DiaryEntry.Links

getset

Gets or Sets Links

Name

string Lusid.Sdk.Model.DiaryEntry.Name

getset

The name of the diary entry.

The name of the diary entry.

PreviousEntryTime

DateTimeOffset Lusid.Sdk.Model.DiaryEntry.PreviousEntryTime

getset

The entry time of the previous diary entry.

The entry time of the previous diary entry.

Properties

Dictionary<string, Property> Lusid.Sdk.Model.DiaryEntry.Properties

getset

A set of properties for the diary entry.

A set of properties for the diary entry.

QueryAsAt

DateTimeOffset Lusid.Sdk.Model.DiaryEntry.QueryAsAt

getset

The query time of the diary entry. Defaults to latest.

The query time of the diary entry. Defaults to latest.

Status

string Lusid.Sdk.Model.DiaryEntry.Status

getset

The status of the diary entry. Statuses are constrained and defaulted by 'Type' specified. Type 'Other' defaults to 'Undefined' and supports 'Undefined', 'Estimate', 'Candidate', and 'Final'. Type 'PeriodBoundary' defaults to 'Estimate' when closing a period, and supports 'Estimate' and 'Final' for closing periods and 'Final' for locking periods. Type 'ValuationPoint' defaults to 'Estimate' when upserting a diary entry, moves to 'Candidate' or 'Final' when a ValuationPoint is accepted, and 'Final' when it is finalised. Available values: Undefined, Estimate, Final, Candidate, Unofficial.

The status of the diary entry. Statuses are constrained and defaulted by 'Type' specified. Type 'Other' defaults to 'Undefined' and supports 'Undefined', 'Estimate', 'Candidate', and 'Final'. Type 'PeriodBoundary' defaults to 'Estimate' when closing a period, and supports 'Estimate' and 'Final' for closing periods and 'Final' for locking periods. Type 'ValuationPoint' defaults to 'Estimate' when upserting a diary entry, moves to 'Candidate' or 'Final' when a ValuationPoint is accepted, and 'Final' when it is finalised. Available values: Undefined, Estimate, Final, Candidate, Unofficial.

Type

string Lusid.Sdk.Model.DiaryEntry.Type

getset

The type of the diary entry. Available values: PeriodBoundary, ValuationPoint, Other.

The type of the diary entry. Available values: PeriodBoundary, ValuationPoint, Other.

VarVersion

ModelVersion Lusid.Sdk.Model.DiaryEntry.VarVersion

getset

Gets or Sets VarVersion

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Model/DiaryEntry.cs