Lusid.Sdk.Model.Schedule Class Reference

Base class for representing schedules in LUSID. This base class should not be directly instantiated; each supported ScheduleType has a corresponding inherited class. More...

Inheritance diagram for Lusid.Sdk.Model.Schedule:

Public Types
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...

Public Member Functions
	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...
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 (Schedule input)
	Returns true if Schedule instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	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
ScheduleTypeEnum	ScheduleType [get, set]
	Available values: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid. More...

Detailed Description

Base class for representing schedules in LUSID. This base class should not be directly instantiated; each supported ScheduleType has a corresponding inherited class.

Member Enumeration Documentation

ScheduleTypeEnum

enum Lusid.Sdk.Model.Schedule.ScheduleTypeEnum

strong

Available values: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid.

Available values: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid.

Enumerator
FixedSchedule	Enum FixedSchedule for value: FixedSchedule
FloatSchedule	Enum FloatSchedule for value: FloatSchedule
OptionalitySchedule	Enum OptionalitySchedule for value: OptionalitySchedule
StepSchedule	Enum StepSchedule for value: StepSchedule
Exercise	Enum Exercise for value: Exercise
FxRateSchedule	Enum FxRateSchedule for value: FxRateSchedule
FxLinkedNotionalSchedule	Enum FxLinkedNotionalSchedule for value: FxLinkedNotionalSchedule
BondConversionSchedule	Enum BondConversionSchedule for value: BondConversionSchedule
Invalid	Enum Invalid for value: Invalid

Constructor & Destructor Documentation

Schedule() [1/2]

Lusid.Sdk.Model.Schedule.Schedule ( )

inlineprotected

Initializes a new instance of the Schedule class.

Schedule() [2/2]

Lusid.Sdk.Model.Schedule.Schedule ( ScheduleTypeEnum  scheduleType = default(ScheduleTypeEnum) )

inline

Initializes a new instance of the Schedule class.

Parameters

scheduleType

Available values: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid. (required).

Member Function Documentation

BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.Schedule.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.Schedule.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.Schedule.Equals ( Schedule  input )

inline

Returns true if Schedule instances are equal

Parameters

input

Instance of Schedule to be compared

Returns

Boolean

GetHashCode()

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

inline

Gets the hash code

Returns

Hash code

ToJson()

virtual string Lusid.Sdk.Model.Schedule.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

Reimplemented in Lusid.Sdk.Model.StepSchedule, Lusid.Sdk.Model.OptionalitySchedule, Lusid.Sdk.Model.FxRateSchedule, Lusid.Sdk.Model.FxLinkedNotionalSchedule, Lusid.Sdk.Model.FloatSchedule, Lusid.Sdk.Model.FixedSchedule, and Lusid.Sdk.Model.BondConversionSchedule.

ToString()

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

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

ScheduleType

ScheduleTypeEnum Lusid.Sdk.Model.Schedule.ScheduleType

getset

Available values: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid.

Available values: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid.

---

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