Schedules

Handles all Security Token Checkpoint Schedules related functionality

Hierarchy

• Namespace‹SecurityToken›

  ↳ Schedules

Index

Properties

• context

• create

• parent

• remove

Methods

• complexityOf

• currentComplexity

• get

• maxComplexity

Properties

Protected context

• context: Context

Inherited from void

Defined in src/api/entities/Namespace.ts:11

create

• create: ProcedureMethod‹CreateCheckpointScheduleParams, CheckpointSchedule›

Defined in src/api/entities/SecurityToken/Checkpoints/Schedules.ts:54

Create a schedule for Checkpoint creation (i.e. "Create a checkpoint every week for 5 weeks, starting next tuesday")

note due to chain limitations, schedules are advanced and (if appropriate) executed whenever the Security Token is redeemed, issued or transferred between portfolios. This means that on a Security Token without much movement, there may be disparities between intended Checkpoint creation dates and the actual date when they are created. This, however, has no effect on the Checkpoint's accuracy regarding to balances

note required role:

• Security Token Owner

Protected parent

• parent: SecurityToken

Inherited from void

Defined in src/api/entities/Namespace.ts:9

remove

• remove: ProcedureMethod‹RemoveCheckpointScheduleParams, void›

Defined in src/api/entities/SecurityToken/Checkpoints/Schedules.ts:64

Remove the supplied Checkpoint Schedule for a given Security Token

param Schedule (or ID) of the schedule to be removed

note required role:

• Security Token Owner

Methods

complexityOf

▸ complexityOf(period: CalendarPeriod): number

Defined in src/api/entities/SecurityToken/Checkpoints/Schedules.ts:102

Calculate an abstract measure of the complexity of a given Calendar Period

Parameters:

Name	Type
period	CalendarPeriod

Returns: number

currentComplexity

▸ currentComplexity(): Promise‹number›

Defined in src/api/entities/SecurityToken/Checkpoints/Schedules.ts:110

Calculate the sum of the complexity of all current Checkpoint Schedules for this Security Token. The number cannot exceed the Token's maximum complexity (obtained via maxComplexity)

Returns: Promise‹number›

get

▸ get(): Promise‹ScheduleWithDetails[]›

Defined in src/api/entities/SecurityToken/Checkpoints/Schedules.ts:69

Retrieve all active Checkpoint Schedules

Returns: Promise‹ScheduleWithDetails[]›

maxComplexity

▸ maxComplexity(): Promise‹number›

Defined in src/api/entities/SecurityToken/Checkpoints/Schedules.ts:119

Retrieve the maximum allowed Schedule complexity for this Security Token

Returns: Promise‹number›