A list of portfolios. More...

Inheritance diagram for Lusid.Sdk.Model.PortfolioSearchResult:

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

Public Member Functions
	PortfolioSearchResult (ResourceId id=default(ResourceId), TypeEnum type=default(TypeEnum), string href=default(string), string description=default(string), string displayName=default(string), DateTimeOffset created=default(DateTimeOffset), ResourceId parentPortfolioId=default(ResourceId), string baseCurrency=default(string), List< Property > properties=default(List< Property >), List< Link > links=default(List< Link >))
	Initializes a new instance of the PortfolioSearchResult 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 (PortfolioSearchResult input)
	Returns true if PortfolioSearchResult instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

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

Properties
TypeEnum	Type `[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...

bool	IsDerived `[get]`
	Whether or not this is a derived 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...

string	BaseCurrency `[get, set]`
	The base currency of the portfolio. This will be an empty string for reference portfolios. More...

List< Property >	Properties `[get, set]`
	The requested portfolio properties. These will be from the 'Portfolio' domain. More...

List< Link >	Links `[get, set]`
	Collection of links. More...

Detailed Description

A list of portfolios.

Member Enumeration Documentation

◆ TypeEnum

enum Lusid.Sdk.Model.PortfolioSearchResult.TypeEnum

strong

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

◆ PortfolioSearchResult() [1/2]

Lusid.Sdk.Model.PortfolioSearchResult.PortfolioSearchResult ( )

inlineprotected

Initializes a new instance of the PortfolioSearchResult class.

◆ PortfolioSearchResult() [2/2]

Lusid.Sdk.Model.PortfolioSearchResult.PortfolioSearchResult	(	ResourceId	id = `default(ResourceId)`,
		TypeEnum	type = `default(TypeEnum)`,
		string	href = `default(string)`,
		string	description = `default(string)`,
		string	displayName = `default(string)`,
		DateTimeOffset	created = `default(DateTimeOffset)`,
		ResourceId	parentPortfolioId = `default(ResourceId)`,
		string	baseCurrency = `default(string)`,
		List< Property >	properties = `default(List<Property>)`,
		List< Link >	links = `default(List<Link>)`
	)

inline

Initializes a new instance of the PortfolioSearchResult class.

Parameters

id	id (required).
type	The type of the portfolio. The available values are: Transaction, Reference, DerivedTransaction (required).
href	The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime..
description	The long form description of the portfolio..
displayName	The name of the portfolio. (required).
created	The effective datetime at which the portfolio was created. No transactions or constituents can be added to the portfolio before this date. (required).
parentPortfolioId	parentPortfolioId.
baseCurrency	The base currency of the portfolio. This will be an empty string for reference portfolios..
properties	The requested portfolio properties. These will be from the 'Portfolio' domain..
links	Collection of links..

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if PortfolioSearchResult instances are equal

Parameters

input Instance of PortfolioSearchResult to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ShouldSerializeIsDerived()

bool Lusid.Sdk.Model.PortfolioSearchResult.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.PortfolioSearchResult.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ BaseCurrency

string Lusid.Sdk.Model.PortfolioSearchResult.BaseCurrency

getset

The base currency of the portfolio. This will be an empty string for reference portfolios.

◆ Created

DateTimeOffset Lusid.Sdk.Model.PortfolioSearchResult.Created

getset

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.PortfolioSearchResult.Description

getset

The long form description of the portfolio.

◆ DisplayName

string Lusid.Sdk.Model.PortfolioSearchResult.DisplayName

getset

The name of the portfolio.

◆ Href

string Lusid.Sdk.Model.PortfolioSearchResult.Href

getset

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

◆ Id

ResourceId Lusid.Sdk.Model.PortfolioSearchResult.Id

getset

Gets or Sets Id

◆ IsDerived

bool Lusid.Sdk.Model.PortfolioSearchResult.IsDerived

get

Whether or not this is a derived portfolio.

◆ Links

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

getset

Collection of links.

◆ ParentPortfolioId

ResourceId Lusid.Sdk.Model.PortfolioSearchResult.ParentPortfolioId

getset

Gets or Sets ParentPortfolioId

◆ Properties

List<Property> Lusid.Sdk.Model.PortfolioSearchResult.Properties

getset

The requested portfolio properties. These will be from the 'Portfolio' domain.

◆ Type

TypeEnum Lusid.Sdk.Model.PortfolioSearchResult.Type

getset

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

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/stable/sdk/Lusid.Sdk/Model/PortfolioSearchResult.cs

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ TypeEnum

Constructor & Destructor Documentation

◆ PortfolioSearchResult() [1/2]

◆ PortfolioSearchResult() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ShouldSerializeIsDerived()

◆ ToJson()

◆ ToString()

Property Documentation

◆ BaseCurrency

◆ Created

◆ Description

◆ DisplayName

◆ Href

◆ Id

◆ IsDerived

◆ Links

◆ ParentPortfolioId

◆ Properties

◆ Type