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

CreateRelationDefinitionRequest More...

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

Public Member Functions

 CreateRelationDefinitionRequest (string scope=default(string), string code=default(string), 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))
 Initializes a new instance of the CreateRelationDefinitionRequest 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 (CreateRelationDefinitionRequest input)
 Returns true if CreateRelationDefinitionRequest instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

string Scope [get, set]
 The scope that the relation exists in. More...
 
string Code [get, set]
 The code of the relation. Together with the scope this uniquely defines the relation. More...
 
string SourceEntityDomain [get, set]
 The entity domain of the source entity object must be, allowed values are "Portfolio" and "Person" More...
 
string TargetEntityDomain [get, set]
 The entity domain of the target entity object must be, allowed values are "Portfolio" and "Person" 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 "Perpetual" and "TimeVariant" 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 "Property" and "Collection", defaults to "Collection" if not specified. More...
 

Detailed Description

CreateRelationDefinitionRequest

Constructor & Destructor Documentation

◆ CreateRelationDefinitionRequest() [1/2]

Lusid.Sdk.Model.CreateRelationDefinitionRequest.CreateRelationDefinitionRequest ( )
inlineprotected

Initializes a new instance of the CreateRelationDefinitionRequest class.

◆ CreateRelationDefinitionRequest() [2/2]

Lusid.Sdk.Model.CreateRelationDefinitionRequest.CreateRelationDefinitionRequest ( string  scope = default(string),
string  code = default(string),
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) 
)
inline

Initializes a new instance of the CreateRelationDefinitionRequest class.

Parameters
scopeThe scope that the relation exists in. (required).
codeThe code of the relation. Together with the scope this uniquely defines the relation. (required).
sourceEntityDomainThe entity domain of the source entity object must be, allowed values are "Portfolio" and "Person" (required).
targetEntityDomainThe entity domain of the target entity object must be, allowed values are "Portfolio" and "Person" (required).
displayNameThe display name of the relation. (required).
outwardDescriptionThe description to relate source entity object and target entity object. (required).
inwardDescriptionThe description to relate target entity object and source entity object. (required).
lifeTimeDescribes how the relations can change over time, allowed values are "Perpetual" and "TimeVariant".
constraintStyleDescribes the uniqueness and cardinality for relations with a specific source entity object and relations under this definition. Allowed values are "Property" and "Collection", defaults to "Collection" if not specified..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if CreateRelationDefinitionRequest instances are equal

Parameters
inputInstance of CreateRelationDefinitionRequest to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Code

string Lusid.Sdk.Model.CreateRelationDefinitionRequest.Code
getset

The code of the relation. Together with the scope this uniquely defines the relation.

The code of the relation. Together with the scope this uniquely defines the relation.

◆ ConstraintStyle

string Lusid.Sdk.Model.CreateRelationDefinitionRequest.ConstraintStyle
getset

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

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

◆ DisplayName

string Lusid.Sdk.Model.CreateRelationDefinitionRequest.DisplayName
getset

The display name of the relation.

The display name of the relation.

◆ InwardDescription

string Lusid.Sdk.Model.CreateRelationDefinitionRequest.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.CreateRelationDefinitionRequest.LifeTime
getset

Describes how the relations can change over time, allowed values are "Perpetual" and "TimeVariant"

Describes how the relations can change over time, allowed values are "Perpetual" and "TimeVariant"

◆ OutwardDescription

string Lusid.Sdk.Model.CreateRelationDefinitionRequest.OutwardDescription
getset

The description to relate source entity object and target entity object.

The description to relate source entity object and target entity object.

◆ Scope

string Lusid.Sdk.Model.CreateRelationDefinitionRequest.Scope
getset

The scope that the relation exists in.

The scope that the relation exists in.

◆ SourceEntityDomain

string Lusid.Sdk.Model.CreateRelationDefinitionRequest.SourceEntityDomain
getset

The entity domain of the source entity object must be, allowed values are "Portfolio" and "Person"

The entity domain of the source entity object must be, allowed values are "Portfolio" and "Person"

◆ TargetEntityDomain

string Lusid.Sdk.Model.CreateRelationDefinitionRequest.TargetEntityDomain
getset

The entity domain of the target entity object must be, allowed values are "Portfolio" and "Person"

The entity domain of the target entity object must be, allowed values are "Portfolio" and "Person"


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