Utility.Registry.V0.Holding.Lock

Templates

template AcceptedLock

An accepted lock.

Signatory: (DA.Internal.Record.getField @"holder" lock), (DA.Internal.Record.getField @"locker" lock)

Field	Type	Description
lock	Lock	Accepted lock payload.
holdingLabel	Text	Label of the holding to lock.

• Choice AcceptedLock_Execute

  Execute an accepted lock.

  Controller: (DA.Internal.Record.getField @"registrar" lock)

  Returns: AcceptedLock_Execute_Result

  Field	Type	Description
  instrumentConfigurationCid	ContractId InstrumentConfiguration	Instrument configuration.
  credentialCids	[ContractId Credential]	Holder credential cids.
  holdingCid	ContractId Holding	Holding to lock.

• Choice AcceptedLock_Fail

  Fail an accepted lock.

  Controller: (DA.Internal.Record.getField @"registrar" lock)

  Returns: AcceptedLock_Fail_Result

  Field	Type	Description
  reason	Text	Reason for failure.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"holder" lock), (DA.Internal.Record.getField @"locker" lock)

  Returns: ()

  (no fields)

template ExecutedLock

An executed lock.

Signatory: (DA.Internal.Record.getField @"registrar" lock)

Field	Type	Description
lock	Lock	Lock payload.
holdingLabel	Text	Label of the holding to lock.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"registrar" lock)

  Returns: ()

  (no fields)

• Choice ExecutedLock_Delete

  Deletes an executed lock.

  Controller: (DA.Internal.Record.getField @"registrar" lock)

  Returns: ExecutedLock_Delete_Result

  (no fields)

template FailedLock

A failed lock.

Signatory: (DA.Internal.Record.getField @"registrar" lock)

Field	Type	Description
lock	Lock	Rejected lock payload.
reason	Text	Reason for failure.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"registrar" lock)

  Returns: ()

  (no fields)

• Choice FailedLock_Delete

  Deletes a rejected lock.

  Controller: (DA.Internal.Record.getField @"registrar" lock)

  Returns: FailedLock_Delete_Result

  (no fields)

template LockOffer

An offer to lock a holding

Signatory: (DA.Internal.Record.getField @"provider" lock), (DA.Internal.Record.getField @"holder" lock)

Field	Type	Description
lock	Lock	Lock offer payload.
holdingLabel	Text	Label of the holding to lock.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"provider" lock), (DA.Internal.Record.getField @"holder" lock)

  Returns: ()

  (no fields)

• Choice LockOffer_Accept

  Accepts a lock offer.

  Controller: (DA.Internal.Record.getField @"locker" lock)

  Returns: LockOffer_Accept_Result

  (no fields)

• Choice LockOffer_Cancel

  Cancels a lock offer.

  Controller: (DA.Internal.Record.getField @"holder" lock)

  Returns: LockOffer_Cancel_Result

  (no fields)

• Choice LockOffer_Reject

  Rejects a lock offer.

  Controller: (DA.Internal.Record.getField @"locker" lock)

  Returns: LockOffer_Reject_Result

  Field	Type	Description
  reason	Text	Reason for rejection.

template LockRequest

A request to lock a holding

Signatory: (DA.Internal.Record.getField @"provider" lock), (DA.Internal.Record.getField @"locker" lock)

Field	Type	Description
lock	Lock	Lock offer payload.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"provider" lock), (DA.Internal.Record.getField @"locker" lock)

  Returns: ()

  (no fields)

• Choice LockRequest_Accept

  Accepts a lock request.

  Controller: (DA.Internal.Record.getField @"holder" lock)

  Returns: LockRequest_Accept_Result

  Field	Type	Description
  holdingLabel	Text	Label of the holding to lock.

• Choice LockRequest_Cancel

  Cancels a lock request.

  Controller: (DA.Internal.Record.getField @"locker" lock)

  Returns: LockRequest_Cancel_Result

  (no fields)

• Choice LockRequest_Reject

  Rejects a lock request.

  Controller: (DA.Internal.Record.getField @"holder" lock)

  Returns: LockRequest_Reject_Result

  Field	Type	Description
  reason	Text	Reason for rejection.

template RejectedLock

A rejected lock request.

Signatory: (DA.Internal.Record.getField @"holder" lock), (DA.Internal.Record.getField @"locker" lock)

Field	Type	Description
lock	Lock	Rejected lock payload.
reason	Text	Reason for rejection.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"holder" lock), (DA.Internal.Record.getField @"locker" lock)

  Returns: ()

  (no fields)

• Choice RejectedLock_Delete

  Deletes a rejected lock.

  Controller: (DA.Internal.Record.getField @"registrar" lock)

  Returns: RejectedLock_Delete_Result

  (no fields)

Data Types

data AcceptedLock_Execute_Result

Result of AcceptedLock_Execute.

AcceptedLock_Execute_Result

Field	Type	Description
holdingLockResult	Holding_Lock_Result	Result of acquiring the lock.
executedLockCid	ContractId ExecutedLock	Executed lock.

data AcceptedLock_Fail_Result

Result of AcceptedLock_Fail.

AcceptedLock_Fail_Result

Field	Type	Description
failedLockCid	ContractId FailedLock	Failed lock.

data ExecutedLock_Delete_Result

Result of ExecutedLock_Delete.

ExecutedLock_Delete_Result

(no fields)

data FailedLock_Delete_Result

Result of FailedLock_Delete.

FailedLock_Delete_Result

(no fields)

data Lock

Lock payload.

Lock

Field	Type	Description
operator	Party	Utility operator.
provider	Party	Provider of the initiator of the lock.
registrar	Party	Registrar of holding.
holder	Party	Holder.
locker	Party	Locker.
instrumentIdentifier	InstrumentIdentifier	Instrument id to lock.
amount	Decimal	Amount to lock.
context	Text	Context for the lock.
reference	Text	Reference for the lock.
batch	Batch	Batch the lock belongs to.

data LockOffer_Accept_Result

Result of LockOffer_Accept.

LockOffer_Accept_Result

Field	Type	Description
acceptedLockCid	ContractId AcceptedLock	Accepted lock.

data LockOffer_Cancel_Result

Result of LockOffer_Reject.

LockOffer_Cancel_Result

(no fields)

data LockOffer_Reject_Result

Result of LockOffer_Reject.

LockOffer_Reject_Result

Field	Type	Description
rejectedLockCid	ContractId RejectedLock	Rejected lock.

data LockRequest_Accept_Result

Result of LockRequest_Accept.

LockRequest_Accept_Result

Field	Type	Description
acceptedLockCid	ContractId AcceptedLock	Accepted lock.

data LockRequest_Cancel_Result

Result of LockRequest_Cancel.

LockRequest_Cancel_Result

(no fields)

data LockRequest_Reject_Result

Result of LockRequest_Reject.

LockRequest_Reject_Result

Field	Type	Description
rejectedLockCid	ContractId RejectedLock	Rejected lock.

data RejectedLock_Delete_Result

Result of RejectedLock_Delete.

RejectedLock_Delete_Result

(no fields)