Daml.Finance.Interface.Data.Reference.Time

This module defines an interface for BusinessTime rules, which are contracts to control and keep track of business time.

Interfaces

interface Time

An interface to manage and control business time. Controlled time rules (i.e. clocks) are managed by entities that have control certain business time events. These can be trading-open / -close on an exchange, start-of-day / end-of-day events of a trading desk, or just a daily clock tick to signal the passing of aticking. Intervals in which the clock "ticks" don’t have to be regular, and can e.g. consider business days only.

viewtype V

• Choice Advance

  Advance time to its next state.

  Controller: (DA.Internal.Record.getField @"providers" (view this))

  Returns: (ContractId Time, ContractId Event)

  Field	Type	Description
  eventId	Id	Event identifier.
  eventDescription	Text	Event description.

• Choice Archive

  Controller: Signatories of implementing template

  Returns: ()

  (no fields)

• Choice GetView

  Retrieves the interface view.

  Controller: viewer

  Returns: View

  Field	Type	Description
  viewer	Party	The party retrieving the view.

• Choice Rewind

  Rewind time to its previous state.

  Controller: (DA.Internal.Record.getField @"providers" (view this))

  Returns: (ContractId Time, ContractId Event)

  Field	Type	Description
  eventId	Id	Event identifier.
  eventDescription	Text	Event description.

• Method advance : ContractId Time -> Advance -> Update (ContractId Time, ContractId Event)

  Implementation of the Advance choice.

• Method rewind : ContractId Time -> Rewind -> Update (ContractId Time, ContractId Event)

  Implementation of the Rewind choice.

Data Types

type I

= Time

Type synonym for Time.

type V

= View

Type synonym for View.

instance HasFromAnyView Time V

data View

View for Time.

View

Field	Type	Description
providers	Parties	Parties controlling time.
id	Id	Textual identifier for the time rule.

instance Eq View

instance Show View

Functions

advance

: Time -> ContractId Time -> Advance -> Update (ContractId Time, ContractId Event)

rewind

: Time -> ContractId Time -> Rewind -> Update (ContractId Time, ContractId Event)