Module Daml.Finance.Interface.Instrument.Generic.Election.Factory

Interfaces

interface Factory

Factory interface to instantiate elections on generic instruments.

• Choice Archive

  (no fields)

• Choice Create

  Create a new Election.

  Field	Type	Description
  actors	Parties	Parties calling the Create choice.
  elector	Party	Parties on behalf of which the election is made.
  counterparty	Party	Faces the elector in the Holding.
  provider	Party	Party that signs the election (together with the elector).
  id	Id	The identifier for an election.
  description	Text	A description of the instrument.
  claim	C	The claim representation of the election (i.e., the elected sub-tree).
  electorIsOwner	Bool	True if election is on behalf of the owner of the holding, False otherwise.
  electionTime	Time	Time at which the election is put forward.
  observers	PartiesMap	Observers of the election.
  amount	Decimal	Number of instrument units to which the election applies.
  instrument	InstrumentKey	The instrument to which the election applies.

• Choice Remove

  Archive an account.

  Field	Type	Description
  actors	Parties	Parties executing the Remove choice.
  electionCid	ContractId I	The election’s contract id.

• Method asDisclosure : I

  Conversion to Disclosure interface.

• Method create’ : Create -> Update (ContractId I)

  Implementation of Create choice.

• Method remove : Remove -> Update ()

  Implementation of Remove choice.

Typeclasses

class Implementation t => HasImplementation t where

Data Types

type F

= Factory

Type synonym for Factory.

type Implementation t

= (HasToInterface t Factory, Implementation t)

Type constraint for requiring templates to implement Factory along with Disclosure.

type V

= View

Type synonym for View.

instance HasFromAnyView Factory V

data View

View

Field	Type	Description
provider	Party	The provider of the Factory.

instance Eq View

instance Show View

Functions

asDisclosure

: Factory -> I

create’

: Factory -> Create -> Update (ContractId I)

remove

: Factory -> Remove -> Update ()