Optionality Schedule represents a class for creation of schedules for optionality (call, put) More...

Inheritance diagram for Lusid.Sdk.Model.OptionalitySchedule:

[legend]

Public Member Functions
	OptionalitySchedule (string exerciseType=default(string), List< OptionEntry > optionEntries=default(List< OptionEntry >), string optionType=default(string), ScheduleTypeEnum scheduleType=default(ScheduleTypeEnum))
	Initializes a new instance of the OptionalitySchedule 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 (OptionalitySchedule input)
	Returns true if OptionalitySchedule 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
	OptionalitySchedule ()
	Initializes a new instance of the OptionalitySchedule 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
string	ExerciseType `[get, set]`
	The exercise type of the optionality schedule (American or European). For American type, the bond is perpetually callable from a given exercise date until it matures, or the next date in the schedule. For European type, the bond is only callable on a given exercise date. Supported string (enumeration) values are: [European, American]. More...

List< OptionEntry >	OptionEntries `[get, set]`
	The dates at which the bond call/put may be actioned, and associated strikes. More...

string	OptionType `[get, set]`
	Type of optionality for the schedule. Supported string (enumeration) values are: [Call, Put]. More...

Properties inherited from Lusid.Sdk.Model.Schedule
ScheduleTypeEnum	ScheduleType `[get, set]`
	The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, 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 , Invalid = 8 }
	The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid More...

Detailed Description

Optionality Schedule represents a class for creation of schedules for optionality (call, put)

Constructor & Destructor Documentation

◆ OptionalitySchedule() [1/2]

Lusid.Sdk.Model.OptionalitySchedule.OptionalitySchedule ( )

inlineprotected

Initializes a new instance of the OptionalitySchedule class.

◆ OptionalitySchedule() [2/2]

Lusid.Sdk.Model.OptionalitySchedule.OptionalitySchedule	(	string	exerciseType = `default(string)`,
		List< OptionEntry >	optionEntries = `default(List<OptionEntry>)`,
		string	optionType = `default(string)`,
		ScheduleTypeEnum	scheduleType = `default(ScheduleTypeEnum)`
	)

inline

Initializes a new instance of the OptionalitySchedule class.

Parameters

exerciseType	The exercise type of the optionality schedule (American or European). For American type, the bond is perpetually callable from a given exercise date until it matures, or the next date in the schedule. For European type, the bond is only callable on a given exercise date. Supported string (enumeration) values are: [European, American]..
optionEntries	The dates at which the bond call/put may be actioned, and associated strikes..
optionType	Type of optionality for the schedule. Supported string (enumeration) values are: [Call, Put]..
scheduleType	The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid (required) (default to "OptionalitySchedule").

Member Function Documentation

◆ BaseValidate()

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

inlineprotected

To validate all properties of the instance

Parameters

validationContext Validation context

Returns: Validation Result

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.OptionalitySchedule.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.OptionalitySchedule.Equals ( OptionalitySchedule input )

inline

Returns true if OptionalitySchedule instances are equal

Parameters

input Instance of OptionalitySchedule to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

override string Lusid.Sdk.Model.OptionalitySchedule.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.OptionalitySchedule.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ ExerciseType

string Lusid.Sdk.Model.OptionalitySchedule.ExerciseType

getset

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

◆ OptionEntries

List<OptionEntry> Lusid.Sdk.Model.OptionalitySchedule.OptionEntries

getset

The dates at which the bond call/put may be actioned, and associated strikes.

◆ OptionType

string Lusid.Sdk.Model.OptionalitySchedule.OptionType

getset

Type of optionality for the schedule. Supported string (enumeration) values are: [Call, Put].

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/OptionalitySchedule.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OptionalitySchedule() [1/2]

◆ OptionalitySchedule() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ ExerciseType

◆ OptionEntries

◆ OptionType