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

Loan Facility. This is a very lightweight instrument which acts as a placeholder for the events occurring within the related facility Portfolio. This Portfolio is identified by its Scope and Code, which is recorded on the instrument definition. The instrument acts as an agreement between a single borrower and many lenders (investors). Several contracts may be drawn up to enable the lending of funds to the borrower. These contracts are modelled via FlexibleLoan instruments in LUSID. The events occurring within the linked Portfolio may be related to the facility as a whole (for example to define a global commitment amount), or they may relate to a single contract (such as a paydown transaction on a particular contract). More...

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

Public Member Functions

 LoanFacility (DateTimeOffset startDate=default(DateTimeOffset), string domCcy=default(string), string facilityPortfolioScope=default(string), string facilityPortfolioCode=default(string), InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum))
 Initializes a new instance of the LoanFacility class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
override 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 (LoanFacility input)
 Returns true if LoanFacility instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
- Public Member Functions inherited from Lusid.Sdk.Model.LusidInstrument
 LusidInstrument (InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum))
 Initializes a new instance of the LusidInstrument class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
override bool Equals (object input)
 Returns true if objects are equal More...
 
bool Equals (LusidInstrument input)
 Returns true if LusidInstrument instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 LoanFacility ()
 Initializes a new instance of the LoanFacility class. More...
 
IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > BaseValidate (ValidationContext validationContext)
 To validate all properties of the instance More...
 
- Protected Member Functions inherited from Lusid.Sdk.Model.LusidInstrument
 LusidInstrument ()
 Initializes a new instance of the LusidInstrument class. More...
 
IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > BaseValidate (ValidationContext validationContext)
 To validate all properties of the instance More...
 

Properties

DateTimeOffset StartDate [get, set]
 The start date of the instrument. This is normally synonymous with the trade-date. More...
 
string DomCcy [get, set]
 The domestic currency of the instrument. More...
 
string FacilityPortfolioScope [get, set]
 The Scope of the Transaction Portfolio to which the Loan Facility instrument is linked. More...
 
string FacilityPortfolioCode [get, set]
 The Code of the Transaction Portfolio to which the Loan Facility instrument is linked. More...
 
- Properties inherited from Lusid.Sdk.Model.LusidInstrument
InstrumentTypeEnum InstrumentType [get, set]
 The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility More...
 

Additional Inherited Members

- Public Types inherited from Lusid.Sdk.Model.LusidInstrument
enum class  InstrumentTypeEnum {
  QuotedSecurity = 1 , InterestRateSwap = 2 , FxForward = 3 , Future = 4 ,
  ExoticInstrument = 5 , FxOption = 6 , CreditDefaultSwap = 7 , InterestRateSwaption = 8 ,
  Bond = 9 , EquityOption = 10 , FixedLeg = 11 , FloatingLeg = 12 ,
  BespokeCashFlowsLeg = 13 , Unknown = 14 , TermDeposit = 15 , ContractForDifference = 16 ,
  EquitySwap = 17 , CashPerpetual = 18 , CapFloor = 19 , CashSettled = 20 ,
  CdsIndex = 21 , Basket = 22 , FundingLeg = 23 , FxSwap = 24 ,
  ForwardRateAgreement = 25 , SimpleInstrument = 26 , Repo = 27 , Equity = 28 ,
  ExchangeTradedOption = 29 , ReferenceInstrument = 30 , ComplexBond = 31 , InflationLinkedBond = 32 ,
  InflationSwap = 33 , SimpleCashFlowLoan = 34 , TotalReturnSwap = 35 , InflationLeg = 36 ,
  FundShareClass = 37 , FlexibleLoan = 38 , UnsettledCash = 39 , Cash = 40 ,
  MasteredInstrument = 41 , LoanFacility = 42
}
 The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility More...
 

Detailed Description

Loan Facility. This is a very lightweight instrument which acts as a placeholder for the events occurring within the related facility Portfolio. This Portfolio is identified by its Scope and Code, which is recorded on the instrument definition. The instrument acts as an agreement between a single borrower and many lenders (investors). Several contracts may be drawn up to enable the lending of funds to the borrower. These contracts are modelled via FlexibleLoan instruments in LUSID. The events occurring within the linked Portfolio may be related to the facility as a whole (for example to define a global commitment amount), or they may relate to a single contract (such as a paydown transaction on a particular contract).

Constructor & Destructor Documentation

◆ LoanFacility() [1/2]

Lusid.Sdk.Model.LoanFacility.LoanFacility ( )
inlineprotected

Initializes a new instance of the LoanFacility class.

◆ LoanFacility() [2/2]

Lusid.Sdk.Model.LoanFacility.LoanFacility ( DateTimeOffset  startDate = default(DateTimeOffset),
string  domCcy = default(string),
string  facilityPortfolioScope = default(string),
string  facilityPortfolioCode = default(string),
InstrumentTypeEnum  instrumentType = default(InstrumentTypeEnum) 
)
inline

Initializes a new instance of the LoanFacility class.

Parameters
startDateThe start date of the instrument. This is normally synonymous with the trade-date. (required).
domCcyThe domestic currency of the instrument. (required).
facilityPortfolioScopeThe Scope of the Transaction Portfolio to which the Loan Facility instrument is linked. (required).
facilityPortfolioCodeThe Code of the Transaction Portfolio to which the Loan Facility instrument is linked. (required).
instrumentTypeThe available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility (required) (default to "LoanFacility").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.LoanFacility.BaseValidate ( ValidationContext  validationContext)
inlineprotected

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if LoanFacility instances are equal

Parameters
inputInstance of LoanFacility to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

override string Lusid.Sdk.Model.LoanFacility.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.LusidInstrument.

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ DomCcy

string Lusid.Sdk.Model.LoanFacility.DomCcy
getset

The domestic currency of the instrument.

The domestic currency of the instrument.

◆ FacilityPortfolioCode

string Lusid.Sdk.Model.LoanFacility.FacilityPortfolioCode
getset

The Code of the Transaction Portfolio to which the Loan Facility instrument is linked.

The Code of the Transaction Portfolio to which the Loan Facility instrument is linked.

◆ FacilityPortfolioScope

string Lusid.Sdk.Model.LoanFacility.FacilityPortfolioScope
getset

The Scope of the Transaction Portfolio to which the Loan Facility instrument is linked.

The Scope of the Transaction Portfolio to which the Loan Facility instrument is linked.

◆ StartDate

DateTimeOffset Lusid.Sdk.Model.LoanFacility.StartDate
getset

The start date of the instrument. This is normally synonymous with the trade-date.

The start date of the instrument. This is normally synonymous with the trade-date.


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