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

An Order for a certain quantity of a specific instrument More...

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

Public Member Functions

 Order (Dictionary< string, PerpetualProperty > properties=default(Dictionary< string, PerpetualProperty >), ModelVersion version=default(ModelVersion), Dictionary< string, string > instrumentIdentifiers=default(Dictionary< string, string >), decimal quantity=default(decimal), string side=default(string), ResourceId orderBookId=default(ResourceId), ResourceId portfolioId=default(ResourceId), ResourceId id=default(ResourceId), string instrumentScope=default(string), string lusidInstrumentId=default(string), string state=default(string), string type=default(string), string timeInForce=default(string), DateTimeOffset date=default(DateTimeOffset), CurrencyAndAmount price=default(CurrencyAndAmount), CurrencyAndAmount limitPrice=default(CurrencyAndAmount), CurrencyAndAmount stopPrice=default(CurrencyAndAmount), ResourceId orderInstructionId=default(ResourceId), ResourceId packageId=default(ResourceId), List< Link > links=default(List< Link >))
 Initializes a new instance of the Order 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 (Order input)
 Returns true if Order instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

Dictionary< string, PerpetualPropertyProperties [get, set]
 Client-defined properties associated with this order. More...
 
ModelVersion _Version [get, set]
 Gets or Sets _Version More...
 
Dictionary< string, string > InstrumentIdentifiers [get, set]
 The instrument ordered. More...
 
decimal Quantity [get, set]
 The quantity of given instrument ordered. More...
 
string Side [get, set]
 The client&#39;s representation of the order&#39;s side (buy, sell, short, etc) More...
 
ResourceId OrderBookId [get, set]
 Gets or Sets OrderBookId More...
 
ResourceId PortfolioId [get, set]
 Gets or Sets PortfolioId More...
 
ResourceId Id [get, set]
 Gets or Sets Id More...
 
string InstrumentScope [get, set]
 The scope in which the instrument lies More...
 
string LusidInstrumentId [get, set]
 The LUSID instrument id for the instrument ordered. More...
 
string State [get, set]
 The order&#39;s state (examples: New, PartiallyFilled, ...) More...
 
string Type [get, set]
 The order&#39;s type (examples: Limit, Market, ...) More...
 
string TimeInForce [get, set]
 The order&#39;s time in force (examples: Day, GoodTilCancel, ...) More...
 
DateTimeOffset Date [get, set]
 The date on which the order was made More...
 
CurrencyAndAmount Price [get, set]
 Gets or Sets Price More...
 
CurrencyAndAmount LimitPrice [get, set]
 Gets or Sets LimitPrice More...
 
CurrencyAndAmount StopPrice [get, set]
 Gets or Sets StopPrice More...
 
ResourceId OrderInstructionId [get, set]
 Gets or Sets OrderInstructionId More...
 
ResourceId PackageId [get, set]
 Gets or Sets PackageId More...
 
List< LinkLinks [get, set]
 Gets or Sets Links More...
 

Detailed Description

An Order for a certain quantity of a specific instrument

Constructor & Destructor Documentation

◆ Order() [1/2]

Lusid.Sdk.Model.Order.Order ( )
inlineprotected

Initializes a new instance of the Order class.

◆ Order() [2/2]

Lusid.Sdk.Model.Order.Order ( Dictionary< string, PerpetualProperty properties = default(Dictionary<string, PerpetualProperty>),
ModelVersion  version = default(ModelVersion),
Dictionary< string, string >  instrumentIdentifiers = default(Dictionary<string, string>),
decimal  quantity = default(decimal),
string  side = default(string),
ResourceId  orderBookId = default(ResourceId),
ResourceId  portfolioId = default(ResourceId),
ResourceId  id = default(ResourceId),
string  instrumentScope = default(string),
string  lusidInstrumentId = default(string),
string  state = default(string),
string  type = default(string),
string  timeInForce = default(string),
DateTimeOffset  date = default(DateTimeOffset),
CurrencyAndAmount  price = default(CurrencyAndAmount),
CurrencyAndAmount  limitPrice = default(CurrencyAndAmount),
CurrencyAndAmount  stopPrice = default(CurrencyAndAmount),
ResourceId  orderInstructionId = default(ResourceId),
ResourceId  packageId = default(ResourceId),
List< Link links = default(List<Link>) 
)
inline

Initializes a new instance of the Order class.

Parameters
propertiesClient-defined properties associated with this order..
versionversion.
instrumentIdentifiersThe instrument ordered. (required).
quantityThe quantity of given instrument ordered. (required).
sideThe client&#39;s representation of the order&#39;s side (buy, sell, short, etc) (required).
orderBookIdorderBookId.
portfolioIdportfolioId.
idid (required).
instrumentScopeThe scope in which the instrument lies.
lusidInstrumentIdThe LUSID instrument id for the instrument ordered. (required).
stateThe order&#39;s state (examples: New, PartiallyFilled, ...).
typeThe order&#39;s type (examples: Limit, Market, ...).
timeInForceThe order&#39;s time in force (examples: Day, GoodTilCancel, ...).
dateThe date on which the order was made.
priceprice.
limitPricelimitPrice.
stopPricestopPrice.
orderInstructionIdorderInstructionId.
packageIdpackageId.
linkslinks.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if Order instances are equal

Parameters
inputInstance of Order to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ _Version

ModelVersion Lusid.Sdk.Model.Order._Version
getset

Gets or Sets _Version

◆ Date

DateTimeOffset Lusid.Sdk.Model.Order.Date
getset

The date on which the order was made

The date on which the order was made

◆ Id

ResourceId Lusid.Sdk.Model.Order.Id
getset

Gets or Sets Id

◆ InstrumentIdentifiers

Dictionary<string, string> Lusid.Sdk.Model.Order.InstrumentIdentifiers
getset

The instrument ordered.

The instrument ordered.

◆ InstrumentScope

string Lusid.Sdk.Model.Order.InstrumentScope
getset

The scope in which the instrument lies

The scope in which the instrument lies

◆ LimitPrice

CurrencyAndAmount Lusid.Sdk.Model.Order.LimitPrice
getset

Gets or Sets LimitPrice

◆ Links

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

Gets or Sets Links

◆ LusidInstrumentId

string Lusid.Sdk.Model.Order.LusidInstrumentId
getset

The LUSID instrument id for the instrument ordered.

The LUSID instrument id for the instrument ordered.

◆ OrderBookId

ResourceId Lusid.Sdk.Model.Order.OrderBookId
getset

Gets or Sets OrderBookId

◆ OrderInstructionId

ResourceId Lusid.Sdk.Model.Order.OrderInstructionId
getset

Gets or Sets OrderInstructionId

◆ PackageId

ResourceId Lusid.Sdk.Model.Order.PackageId
getset

Gets or Sets PackageId

◆ PortfolioId

ResourceId Lusid.Sdk.Model.Order.PortfolioId
getset

Gets or Sets PortfolioId

◆ Price

CurrencyAndAmount Lusid.Sdk.Model.Order.Price
getset

Gets or Sets Price

◆ Properties

Dictionary<string, PerpetualProperty> Lusid.Sdk.Model.Order.Properties
getset

Client-defined properties associated with this order.

Client-defined properties associated with this order.

◆ Quantity

decimal Lusid.Sdk.Model.Order.Quantity
getset

The quantity of given instrument ordered.

The quantity of given instrument ordered.

◆ Side

string Lusid.Sdk.Model.Order.Side
getset

The client&#39;s representation of the order&#39;s side (buy, sell, short, etc)

The client&#39;s representation of the order&#39;s side (buy, sell, short, etc)

◆ State

string Lusid.Sdk.Model.Order.State
getset

The order&#39;s state (examples: New, PartiallyFilled, ...)

The order&#39;s state (examples: New, PartiallyFilled, ...)

◆ StopPrice

CurrencyAndAmount Lusid.Sdk.Model.Order.StopPrice
getset

Gets or Sets StopPrice

◆ TimeInForce

string Lusid.Sdk.Model.Order.TimeInForce
getset

The order&#39;s time in force (examples: Day, GoodTilCancel, ...)

The order&#39;s time in force (examples: Day, GoodTilCancel, ...)

◆ Type

string Lusid.Sdk.Model.Order.Type
getset

The order&#39;s type (examples: Limit, Market, ...)

The order&#39;s type (examples: Limit, Market, ...)


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