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

RelationDefinition More...

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

Public Member Functions

 RelationDefinition (ModelVersion version=default(ModelVersion), ResourceId relationDefinitionId=default(ResourceId), string sourceEntityDomain=default(string), string targetEntityDomain=default(string), string displayName=default(string), string outwardDescription=default(string), string inwardDescription=default(string), string lifeTime=default(string), string constraintStyle=default(string), List< Link > links=default(List< Link >))
 Initializes a new instance of the RelationDefinition 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 (RelationDefinition input)
 Returns true if RelationDefinition instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Properties

ModelVersion _Version [get, set]
 Gets or Sets _Version More...
 
ResourceId RelationDefinitionId [get, set]
 Gets or Sets RelationDefinitionId More...
 
string SourceEntityDomain [get, set]
 The entity domain of the source entity object. More...
 
string TargetEntityDomain [get, set]
 The entity domain of the target entity object. More...
 
string DisplayName [get, set]
 The display name of the relation. More...
 
string OutwardDescription [get, set]
 The description to relate source entity object and target entity object More...
 
string InwardDescription [get, set]
 The description to relate target entity object and source entity object More...
 
string LifeTime [get, set]
 Describes how the relations can change over time, allowed values are &quot;Perpetual&quot; and &quot;TimeVariant&quot; More...
 
string ConstraintStyle [get, set]
 Describes the uniqueness and cardinality for relations with a specific source entity object and relations under this definition. Allowed values are &quot;Property&quot; and &quot;Collection&quot;, defaults to &quot;Collection&quot; if not specified. More...
 
List< LinkLinks [get, set]
 Gets or Sets Links More...
 

Detailed Description

RelationDefinition

Constructor & Destructor Documentation

◆ RelationDefinition()

Lusid.Sdk.Model.RelationDefinition.RelationDefinition ( ModelVersion  version = default(ModelVersion),
ResourceId  relationDefinitionId = default(ResourceId),
string  sourceEntityDomain = default(string),
string  targetEntityDomain = default(string),
string  displayName = default(string),
string  outwardDescription = default(string),
string  inwardDescription = default(string),
string  lifeTime = default(string),
string  constraintStyle = default(string),
List< Link links = default(List<Link>) 
)
inline

Initializes a new instance of the RelationDefinition class.

Parameters
versionversion.
relationDefinitionIdrelationDefinitionId.
sourceEntityDomainThe entity domain of the source entity object..
targetEntityDomainThe entity domain of the target entity object..
displayNameThe display name of the relation..
outwardDescriptionThe description to relate source entity object and target entity object.
inwardDescriptionThe description to relate target entity object and source entity object.
lifeTimeDescribes how the relations can change over time, allowed values are &quot;Perpetual&quot; and &quot;TimeVariant&quot;.
constraintStyleDescribes the uniqueness and cardinality for relations with a specific source entity object and relations under this definition. Allowed values are &quot;Property&quot; and &quot;Collection&quot;, defaults to &quot;Collection&quot; if not specified..
linkslinks.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if RelationDefinition instances are equal

Parameters
inputInstance of RelationDefinition to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ _Version

ModelVersion Lusid.Sdk.Model.RelationDefinition._Version
getset

Gets or Sets _Version

◆ ConstraintStyle

string Lusid.Sdk.Model.RelationDefinition.ConstraintStyle
getset

Describes the uniqueness and cardinality for relations with a specific source entity object and relations under this definition. Allowed values are &quot;Property&quot; and &quot;Collection&quot;, defaults to &quot;Collection&quot; if not specified.

Describes the uniqueness and cardinality for relations with a specific source entity object and relations under this definition. Allowed values are &quot;Property&quot; and &quot;Collection&quot;, defaults to &quot;Collection&quot; if not specified.

◆ DisplayName

string Lusid.Sdk.Model.RelationDefinition.DisplayName
getset

The display name of the relation.

The display name of the relation.

◆ InwardDescription

string Lusid.Sdk.Model.RelationDefinition.InwardDescription
getset

The description to relate target entity object and source entity object

The description to relate target entity object and source entity object

◆ LifeTime

string Lusid.Sdk.Model.RelationDefinition.LifeTime
getset

Describes how the relations can change over time, allowed values are &quot;Perpetual&quot; and &quot;TimeVariant&quot;

Describes how the relations can change over time, allowed values are &quot;Perpetual&quot; and &quot;TimeVariant&quot;

◆ Links

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

Gets or Sets Links

◆ OutwardDescription

string Lusid.Sdk.Model.RelationDefinition.OutwardDescription
getset

The description to relate source entity object and target entity object

The description to relate source entity object and target entity object

◆ RelationDefinitionId

ResourceId Lusid.Sdk.Model.RelationDefinition.RelationDefinitionId
getset

Gets or Sets RelationDefinitionId

◆ SourceEntityDomain

string Lusid.Sdk.Model.RelationDefinition.SourceEntityDomain
getset

The entity domain of the source entity object.

The entity domain of the source entity object.

◆ TargetEntityDomain

string Lusid.Sdk.Model.RelationDefinition.TargetEntityDomain
getset

The entity domain of the target entity object.

The entity domain of the target entity object.


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