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

CompletePortfolio More...

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

Public Types

enum class  TypeEnum { Transaction = 1 , Reference = 2 , DerivedTransaction = 3 }
 The type of the portfolio. The available values are: Transaction, Reference, DerivedTransaction More...
 

Public Member Functions

 CompletePortfolio (ResourceId id=default(ResourceId), string href=default(string), string description=default(string), string displayName=default(string), DateTimeOffset created=default(DateTimeOffset), ResourceId parentPortfolioId=default(ResourceId), TypeEnum? type=default(TypeEnum?), ModelVersion version=default(ModelVersion), List< Property > properties=default(List< Property >), string baseCurrency=default(string), List< string > subHoldingKeys=default(List< string >), List< Link > links=default(List< Link >))
 Initializes a new instance of the CompletePortfolio class. More...
 
bool ShouldSerializeIsDerived ()
 Returns false as IsDerived should not be serialized given that it's read-only. 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 (CompletePortfolio input)
 Returns true if CompletePortfolio instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

TypeEnumType [get, set]
 The type of the portfolio. The available values are: Transaction, Reference, DerivedTransaction More...
 
ResourceId Id [get, set]
 Gets or Sets Id More...
 
string Href [get, set]
 The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime. More...
 
string Description [get, set]
 The long form description of the portfolio. More...
 
string DisplayName [get, set]
 The name of the portfolio. More...
 
DateTimeOffset Created [get, set]
 The effective datetime at which the portfolio was created. No transactions or constituents can be added to the portfolio before this date. More...
 
ResourceId ParentPortfolioId [get, set]
 Gets or Sets ParentPortfolioId More...
 
bool IsDerived [get]
 Whether or not this is a derived portfolio. More...
 
ModelVersion _Version [get, set]
 Gets or Sets _Version More...
 
List< PropertyProperties [get, set]
 The requested portfolio properties. These will be from the &#39;Portfolio&#39; domain. More...
 
string BaseCurrency [get, set]
 If the portfolio is a transaction portfolio or derived transaction portfolio, this is the base currency of the portfolio. More...
 
List< string > SubHoldingKeys [get, set]
 The sub holding key properties configured for the portfolio More...
 
List< LinkLinks [get, set]
 Gets or Sets Links More...
 

Detailed Description

CompletePortfolio

Member Enumeration Documentation

◆ TypeEnum

The type of the portfolio. The available values are: Transaction, Reference, DerivedTransaction

The type of the portfolio. The available values are: Transaction, Reference, DerivedTransaction

Enumerator
Transaction 

Enum Transaction for value: Transaction

Reference 

Enum Reference for value: Reference

DerivedTransaction 

Enum DerivedTransaction for value: DerivedTransaction

Constructor & Destructor Documentation

◆ CompletePortfolio() [1/2]

Lusid.Sdk.Model.CompletePortfolio.CompletePortfolio ( )
inlineprotected

Initializes a new instance of the CompletePortfolio class.

◆ CompletePortfolio() [2/2]

Lusid.Sdk.Model.CompletePortfolio.CompletePortfolio ( ResourceId  id = default(ResourceId),
string  href = default(string),
string  description = default(string),
string  displayName = default(string),
DateTimeOffset  created = default(DateTimeOffset),
ResourceId  parentPortfolioId = default(ResourceId),
TypeEnum type = default(TypeEnum?),
ModelVersion  version = default(ModelVersion),
List< Property properties = default(List<Property>),
string  baseCurrency = default(string),
List< string >  subHoldingKeys = default(List<string>),
List< Link links = default(List<Link>) 
)
inline

Initializes a new instance of the CompletePortfolio class.

Parameters
idid (required).
hrefThe specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime..
descriptionThe long form description of the portfolio..
displayNameThe name of the portfolio..
createdThe effective datetime at which the portfolio was created. No transactions or constituents can be added to the portfolio before this date..
parentPortfolioIdparentPortfolioId.
typeThe type of the portfolio. The available values are: Transaction, Reference, DerivedTransaction.
versionversion (required).
propertiesThe requested portfolio properties. These will be from the &#39;Portfolio&#39; domain..
baseCurrencyIf the portfolio is a transaction portfolio or derived transaction portfolio, this is the base currency of the portfolio..
subHoldingKeysThe sub holding key properties configured for the portfolio.
linkslinks.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if CompletePortfolio instances are equal

Parameters
inputInstance of CompletePortfolio to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ShouldSerializeIsDerived()

bool Lusid.Sdk.Model.CompletePortfolio.ShouldSerializeIsDerived ( )
inline

Returns false as IsDerived should not be serialized given that it's read-only.

Returns
false (boolean)

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ _Version

ModelVersion Lusid.Sdk.Model.CompletePortfolio._Version
getset

Gets or Sets _Version

◆ BaseCurrency

string Lusid.Sdk.Model.CompletePortfolio.BaseCurrency
getset

If the portfolio is a transaction portfolio or derived transaction portfolio, this is the base currency of the portfolio.

If the portfolio is a transaction portfolio or derived transaction portfolio, this is the base currency of the portfolio.

◆ Created

DateTimeOffset Lusid.Sdk.Model.CompletePortfolio.Created
getset

The effective datetime at which the portfolio was created. No transactions or constituents can be added to the portfolio before this date.

The effective datetime at which the portfolio was created. No transactions or constituents can be added to the portfolio before this date.

◆ Description

string Lusid.Sdk.Model.CompletePortfolio.Description
getset

The long form description of the portfolio.

The long form description of the portfolio.

◆ DisplayName

string Lusid.Sdk.Model.CompletePortfolio.DisplayName
getset

The name of the portfolio.

The name of the portfolio.

◆ Href

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

◆ Id

ResourceId Lusid.Sdk.Model.CompletePortfolio.Id
getset

Gets or Sets Id

◆ IsDerived

bool Lusid.Sdk.Model.CompletePortfolio.IsDerived
get

Whether or not this is a derived portfolio.

Whether or not this is a derived portfolio.

◆ Links

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

Gets or Sets Links

◆ ParentPortfolioId

ResourceId Lusid.Sdk.Model.CompletePortfolio.ParentPortfolioId
getset

Gets or Sets ParentPortfolioId

◆ Properties

List<Property> Lusid.Sdk.Model.CompletePortfolio.Properties
getset

The requested portfolio properties. These will be from the &#39;Portfolio&#39; domain.

The requested portfolio properties. These will be from the &#39;Portfolio&#39; domain.

◆ SubHoldingKeys

List<string> Lusid.Sdk.Model.CompletePortfolio.SubHoldingKeys
getset

The sub holding key properties configured for the portfolio

The sub holding key properties configured for the portfolio

◆ Type

TypeEnum? Lusid.Sdk.Model.CompletePortfolio.Type
getset

The type of the portfolio. The available values are: Transaction, Reference, DerivedTransaction

The type of the portfolio. The available values are: Transaction, Reference, DerivedTransaction


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