A BondConversionSchedule object represents a class containing the information required for the creation of convertible features in a ComplexBond More...

Inheritance diagram for Lusid.Sdk.Model.BondConversionSchedule:

[legend]

Public Member Functions
	BondConversionSchedule (Dictionary< string, string > identifiers=default(Dictionary< string, string >), List< BondConversionEntry > bondConversionEntries=default(List< BondConversionEntry >), string conversionTrigger=default(string), string deliveryType=default(string), string exerciseType=default(string), bool includesAccrued=default(bool), bool mandatoryConversion=default(bool), DateTimeOffset notificationPeriodEnd=default(DateTimeOffset), DateTimeOffset notificationPeriodStart=default(DateTimeOffset), ScheduleTypeEnum scheduleType=default(ScheduleTypeEnum))
	Initializes a new instance of the BondConversionSchedule 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 (BondConversionSchedule input)
	Returns true if BondConversionSchedule instances are equal More...

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

Public Member Functions inherited from Lusid.Sdk.Model.Schedule
	Schedule (ScheduleTypeEnum scheduleType=default(ScheduleTypeEnum))
	Initializes a new instance of the Schedule 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 (Schedule input)
	Returns true if Schedule instances are equal More...

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

Protected Member Functions
	BondConversionSchedule ()
	Initializes a new instance of the BondConversionSchedule 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.Schedule
	Schedule ()
	Initializes a new instance of the Schedule class. More...

IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult >	BaseValidate (ValidationContext validationContext)
	To validate all properties of the instance More...

Properties
Dictionary< string, string >	Identifiers `[get, set]`
	The market identifier(s) of the share that the bond converts to. The instrument will not fail validation if no identifier is supplied. More...

List< BondConversionEntry >	BondConversionEntries `[get, set]`
	The dates at which the bond may be converted and associated information required about the conversion. More...

string	ConversionTrigger `[get, set]`
	Corporate event that triggers a conversion Supported string (enumeration) values are: [NextEquityFinancing, IpoConversion, KnownDates, SoftCall]. More...

string	DeliveryType `[get, set]`
	Is a conversion made into cash or into shares? Defaults to "Physical" if not set. Supported string (enumeration) values are: [Cash, Physical]. More...

string	ExerciseType `[get, set]`
	The exercise type of the conversion schedule (American or European). For American type, the bond is convertible from a given exercise date until the next date in the schedule, or until it matures. For European type, the bond is only convertible on the given exercise date. Supported string (enumeration) values are: [European, Bermudan, American]. More...

bool	IncludesAccrued `[get, set]`
	Set this to true if a accrued interest is included in the conversion. Defaults to true. More...

bool	MandatoryConversion `[get, set]`
	Set this to true if a conversion is mandatory if the trigger occurs. Defaults to false. More...

DateTimeOffset	NotificationPeriodEnd `[get, set]`
	The last day in the notification period for the conversion of the bond More...

DateTimeOffset	NotificationPeriodStart `[get, set]`
	The first day in the notification period for the conversion of the bond More...

Properties inherited from Lusid.Sdk.Model.Schedule
ScheduleTypeEnum	ScheduleType `[get, set]`
	Available values: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid. More...

Additional Inherited Members
Public Types inherited from Lusid.Sdk.Model.Schedule
enum class	ScheduleTypeEnum { FixedSchedule = 1 , FloatSchedule = 2 , OptionalitySchedule = 3 , StepSchedule = 4 , Exercise = 5 , FxRateSchedule = 6 , FxLinkedNotionalSchedule = 7 , BondConversionSchedule = 8 , Invalid = 9 }
	Available values: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid. More...

Detailed Description

A BondConversionSchedule object represents a class containing the information required for the creation of convertible features in a ComplexBond

Constructor & Destructor Documentation

◆ BondConversionSchedule() [1/2]

Lusid.Sdk.Model.BondConversionSchedule.BondConversionSchedule ( )

inlineprotected

Initializes a new instance of the BondConversionSchedule class.

◆ BondConversionSchedule() [2/2]

Lusid.Sdk.Model.BondConversionSchedule.BondConversionSchedule	(	Dictionary< string, string >	identifiers = `default(Dictionary<string, string>)`,
		List< BondConversionEntry >	bondConversionEntries = `default(List<BondConversionEntry>)`,
		string	conversionTrigger = `default(string)`,
		string	deliveryType = `default(string)`,
		string	exerciseType = `default(string)`,
		bool	includesAccrued = `default(bool)`,
		bool	mandatoryConversion = `default(bool)`,
		DateTimeOffset	notificationPeriodEnd = `default(DateTimeOffset)`,
		DateTimeOffset	notificationPeriodStart = `default(DateTimeOffset)`,
		ScheduleTypeEnum	scheduleType = `default(ScheduleTypeEnum)`
	)

inline

Initializes a new instance of the BondConversionSchedule class.

Parameters

identifiers	The market identifier(s) of the share that the bond converts to. The instrument will not fail validation if no identifier is supplied..
bondConversionEntries	The dates at which the bond may be converted and associated information required about the conversion..
conversionTrigger	Corporate event that triggers a conversion Supported string (enumeration) values are: [NextEquityFinancing, IpoConversion, KnownDates, SoftCall]. (required).
deliveryType	Is a conversion made into cash or into shares? Defaults to "Physical" if not set. Supported string (enumeration) values are: [Cash, Physical]..
exerciseType	The exercise type of the conversion schedule (American or European). For American type, the bond is convertible from a given exercise date until the next date in the schedule, or until it matures. For European type, the bond is only convertible on the given exercise date. Supported string (enumeration) values are: [European, Bermudan, American]. (required).
includesAccrued	Set this to true if a accrued interest is included in the conversion. Defaults to true..
mandatoryConversion	Set this to true if a conversion is mandatory if the trigger occurs. Defaults to false..
notificationPeriodEnd	The last day in the notification period for the conversion of the bond.
notificationPeriodStart	The first day in the notification period for the conversion of the bond.
scheduleType	Available values: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid. (required) (default to "BondConversionSchedule").

Member Function Documentation

◆ BaseValidate()

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

inlineprotected

To validate all properties of the instance

Parameters

validationContext Validation context

Returns: Validation Result

◆ Equals() [1/2]

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

inline

Returns true if BondConversionSchedule instances are equal

Parameters

input Instance of BondConversionSchedule to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

override string Lusid.Sdk.Model.BondConversionSchedule.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.Schedule.

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ BondConversionEntries

List<BondConversionEntry> Lusid.Sdk.Model.BondConversionSchedule.BondConversionEntries

getset

The dates at which the bond may be converted and associated information required about the conversion.

◆ ConversionTrigger

string Lusid.Sdk.Model.BondConversionSchedule.ConversionTrigger

getset

Corporate event that triggers a conversion Supported string (enumeration) values are: [NextEquityFinancing, IpoConversion, KnownDates, SoftCall].

◆ DeliveryType

string Lusid.Sdk.Model.BondConversionSchedule.DeliveryType

getset

Is a conversion made into cash or into shares? Defaults to "Physical" if not set. Supported string (enumeration) values are: [Cash, Physical].

◆ ExerciseType

string Lusid.Sdk.Model.BondConversionSchedule.ExerciseType

getset

The exercise type of the conversion schedule (American or European). For American type, the bond is convertible from a given exercise date until the next date in the schedule, or until it matures. For European type, the bond is only convertible on the given exercise date. Supported string (enumeration) values are: [European, Bermudan, American].

◆ Identifiers

Dictionary<string, string> Lusid.Sdk.Model.BondConversionSchedule.Identifiers

getset

The market identifier(s) of the share that the bond converts to. The instrument will not fail validation if no identifier is supplied.

◆ IncludesAccrued

bool Lusid.Sdk.Model.BondConversionSchedule.IncludesAccrued

getset

Set this to true if a accrued interest is included in the conversion. Defaults to true.

◆ MandatoryConversion

bool Lusid.Sdk.Model.BondConversionSchedule.MandatoryConversion

getset

Set this to true if a conversion is mandatory if the trigger occurs. Defaults to false.

◆ NotificationPeriodEnd

DateTimeOffset Lusid.Sdk.Model.BondConversionSchedule.NotificationPeriodEnd

getset

The last day in the notification period for the conversion of the bond

◆ NotificationPeriodStart

DateTimeOffset Lusid.Sdk.Model.BondConversionSchedule.NotificationPeriodStart

getset

The first day in the notification period for the conversion of the bond

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

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

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BondConversionSchedule() [1/2]

◆ BondConversionSchedule() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ BondConversionEntries

◆ ConversionTrigger

◆ DeliveryType

◆ ExerciseType

◆ Identifiers

◆ IncludesAccrued

◆ MandatoryConversion

◆ NotificationPeriodEnd

◆ NotificationPeriodStart