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

Information about the other related entity in the relationship More...

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

Public Member Functions

 RelatedEntity (string entityType=default(string), Dictionary< string, string > entityId=default(Dictionary< string, string >), string displayName=default(string), Dictionary< string, Property > properties=default(Dictionary< string, Property >), string scope=default(string), LusidUniqueId lusidUniqueId=default(LusidUniqueId), List< EntityIdentifier > identifiers=default(List< EntityIdentifier >), string href=default(string))
 Initializes a new instance of the RelatedEntity 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 (RelatedEntity input)
 Returns true if RelatedEntity instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 RelatedEntity ()
 Initializes a new instance of the RelatedEntity class. More...
 

Properties

string EntityType [get, set]
 The type of the entity. More...
 
Dictionary< string, string > EntityId [get, set]
 The identifier of the other related entity in the relationship. It contains &#39;scope&#39; and &#39;code&#39; as keys for identifiers of a Portfolio or Portfolio Group, or &#39;idTypeScope&#39;, &#39;idTypeCode&#39;, &#39;code&#39; as keys for identifiers of a Person or Legal entity, or &#39;scope&#39;, &#39;identifierType&#39;, &#39;identifierValue&#39; as keys for identifiers of an Instrument More...
 
string DisplayName [get, set]
 The display name of the entity. More...
 
Dictionary< string, PropertyProperties [get, set]
 The properties of the entity. This field is empty until further notice. More...
 
string Scope [get, set]
 The scope of the identifier More...
 
LusidUniqueId LusidUniqueId [get, set]
 Gets or Sets LusidUniqueId More...
 
List< EntityIdentifierIdentifiers [get, set]
 The identifiers of the related entity in the relationship. More...
 
string Href [get, set]
 The link to the entity. More...
 

Detailed Description

Information about the other related entity in the relationship

Constructor & Destructor Documentation

◆ RelatedEntity() [1/2]

Lusid.Sdk.Model.RelatedEntity.RelatedEntity ( )
inlineprotected

Initializes a new instance of the RelatedEntity class.

◆ RelatedEntity() [2/2]

Lusid.Sdk.Model.RelatedEntity.RelatedEntity ( string  entityType = default(string),
Dictionary< string, string >  entityId = default(Dictionary<string, string>),
string  displayName = default(string),
Dictionary< string, Property properties = default(Dictionary<string, Property>),
string  scope = default(string),
LusidUniqueId  lusidUniqueId = default(LusidUniqueId),
List< EntityIdentifier identifiers = default(List<EntityIdentifier>),
string  href = default(string) 
)
inline

Initializes a new instance of the RelatedEntity class.

Parameters
entityTypeThe type of the entity. (required).
entityIdThe identifier of the other related entity in the relationship. It contains &#39;scope&#39; and &#39;code&#39; as keys for identifiers of a Portfolio or Portfolio Group, or &#39;idTypeScope&#39;, &#39;idTypeCode&#39;, &#39;code&#39; as keys for identifiers of a Person or Legal entity, or &#39;scope&#39;, &#39;identifierType&#39;, &#39;identifierValue&#39; as keys for identifiers of an Instrument (required).
displayNameThe display name of the entity. (required).
propertiesThe properties of the entity. This field is empty until further notice..
scopeThe scope of the identifier.
lusidUniqueIdlusidUniqueId.
identifiersThe identifiers of the related entity in the relationship. (required).
hrefThe link to the entity..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if RelatedEntity instances are equal

Parameters
inputInstance of RelatedEntity to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ DisplayName

string Lusid.Sdk.Model.RelatedEntity.DisplayName
getset

The display name of the entity.

The display name of the entity.

◆ EntityId

Dictionary<string, string> Lusid.Sdk.Model.RelatedEntity.EntityId
getset

The identifier of the other related entity in the relationship. It contains &#39;scope&#39; and &#39;code&#39; as keys for identifiers of a Portfolio or Portfolio Group, or &#39;idTypeScope&#39;, &#39;idTypeCode&#39;, &#39;code&#39; as keys for identifiers of a Person or Legal entity, or &#39;scope&#39;, &#39;identifierType&#39;, &#39;identifierValue&#39; as keys for identifiers of an Instrument

The identifier of the other related entity in the relationship. It contains &#39;scope&#39; and &#39;code&#39; as keys for identifiers of a Portfolio or Portfolio Group, or &#39;idTypeScope&#39;, &#39;idTypeCode&#39;, &#39;code&#39; as keys for identifiers of a Person or Legal entity, or &#39;scope&#39;, &#39;identifierType&#39;, &#39;identifierValue&#39; as keys for identifiers of an Instrument

◆ EntityType

string Lusid.Sdk.Model.RelatedEntity.EntityType
getset

The type of the entity.

The type of the entity.

◆ Href

string Lusid.Sdk.Model.RelatedEntity.Href
getset

The link to the entity.

The link to the entity.

◆ Identifiers

List<EntityIdentifier> Lusid.Sdk.Model.RelatedEntity.Identifiers
getset

The identifiers of the related entity in the relationship.

The identifiers of the related entity in the relationship.

◆ LusidUniqueId

LusidUniqueId Lusid.Sdk.Model.RelatedEntity.LusidUniqueId
getset

Gets or Sets LusidUniqueId

◆ Properties

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

The properties of the entity. This field is empty until further notice.

The properties of the entity. This field is empty until further notice.

◆ Scope

string Lusid.Sdk.Model.RelatedEntity.Scope
getset

The scope of the identifier

The scope of the identifier


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