Utility.Registry.V0.Holding.ForceTransfer

Templates

template AcceptedForceTransfer

Signatory: (DA.Internal.Record.getField @"provider" (DA.Internal.Record.getField @"transfer" forceTransfer)), (DA.Internal.Record.getField @"requestor" forceTransfer), (DA.Internal.Record.getField @"sender" (DA.Internal.Record.getField @"transfer" forceTransfer)), (DA.Internal.Record.getField @"receiver" (DA.Internal.Record.getField @"transfer" forceTransfer))

Field	Type	Description
forceTransfer	ForceTransfer	The accepted force transfer payload.
registrarRationale	Text	Registrar’s rationale for accepting the request.

• Choice AcceptedForceTransfer_Execute

  Executes the accepted force transfer request.

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

  Returns: AcceptedForceTransfer_Execute_Result

  Field	Type	Description
  instrumentConfigurationCid	ContractId InstrumentConfiguration	Instrument configuration.
  holdingCids	[ContractId Holding]	Holdings to use for transfer.
  requestorCredentialCids	[ContractId Credential]	Credentials of requestor.

• Choice AcceptedForceTransfer_Fail

  Fail an accepted lock.

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

  Returns: AcceptedForceTransfer_Fail_Result

  Field	Type	Description
  reason	Text	Reason for failure.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"provider" (DA.Internal.Record.getField @"transfer" forceTransfer)), (DA.Internal.Record.getField @"requestor" forceTransfer), (DA.Internal.Record.getField @"sender" (DA.Internal.Record.getField @"transfer" forceTransfer)), (DA.Internal.Record.getField @"receiver" (DA.Internal.Record.getField @"transfer" forceTransfer))

  Returns: ()

  (no fields)

template ExecutedForceTransfer

An executed force transfer.

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

Field	Type	Description
forceTransfer	ForceTransfer	Force transfer payload.
registrarRationale	Text	Registrar’s rationale for accepting the request.

• Choice Archive

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

  Returns: ()

  (no fields)

• Choice ExecutedForceTransfer_Delete

  Deletes an executed transfer.

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

  Returns: ExecutedForceTransfer_Delete_Result

  (no fields)

template FailedForceTransfer

A failed force transfer.

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

Field	Type	Description
forceTransfer	ForceTransfer	Rejected force transfer payload.
reason	Text	Reason for failure.

• Choice Archive

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

  Returns: ()

  (no fields)

• Choice FailedForceTransfer_Delete

  Deletes a rejected force transfer.

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

  Returns: FailedForceTransfer_Delete_Result

  (no fields)

template ForceTransferRequest

A request to force transfer.

Signatory: (DA.Internal.Record.getField @"provider" (DA.Internal.Record.getField @"transfer" forceTransfer)), (DA.Internal.Record.getField @"requestor" forceTransfer)

Field	Type	Description
forceTransfer	ForceTransfer	The force transfer payload.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"provider" (DA.Internal.Record.getField @"transfer" forceTransfer)), (DA.Internal.Record.getField @"requestor" forceTransfer)

  Returns: ()

  (no fields)

• Choice ForceTransferRequest_Accept

  Accepts request.

  Controller: (DA.Internal.Record.getField @"registrar" (DA.Internal.Record.getField @"transfer" forceTransfer)), (DA.Internal.Record.getField @"sender" (DA.Internal.Record.getField @"transfer" forceTransfer)), (DA.Internal.Record.getField @"receiver" (DA.Internal.Record.getField @"transfer" forceTransfer))

  Returns: ForceTransferRequest_Accept_Result

  Field	Type	Description
  registrarRationale	Text	Registrar’s rationale for accepting the request.

• Choice ForceTransferRequest_Cancel

  Cancels request.

  Controller: (DA.Internal.Record.getField @"requestor" forceTransfer)

  Returns: ForceTransferRequest_Cancel_Result

  (no fields)

• Choice ForceTransferRequest_Reject

  Rejects request.

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

  Returns: ForceTransferRequest_Reject_Result

  Field	Type	Description
  reason	Text	Rejection reason.

template RejectedForceTransfer

A rejected force transfer.

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

Field	Type	Description
forceTransfer	ForceTransfer	The rejected request payload.
reason	Text	The rejection reason.

• Choice Archive

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

  Returns: ()

  (no fields)

• Choice RejectedForceTransfer_Delete

  Deletes a rejected enforcement service request.

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

  Returns: RejectedForceTransfer_Delete_Result

  (no fields)

Data Types

data AcceptedForceTransfer_Execute_Result

Result of ForceTransferRequest_Execute.

AcceptedForceTransfer_Execute_Result

Field	Type	Description
holdingTransferResult	Holding_Transfer_Result	Result of transferring the holding.
executedForceTransferCid	ContractId ExecutedForceTransfer	Executed force transfer.
remainingHoldingCids	[ContractId Holding]	Remaining holdings.

data AcceptedForceTransfer_Fail_Result

Result of AcceptedLock_Fail.

AcceptedForceTransfer_Fail_Result

Field	Type	Description
failedForceTransferCid	ContractId FailedForceTransfer	Failed force transfer.

data ExecutedForceTransfer_Delete_Result

Result of ExecutedForceTransfer_Delete.

ExecutedForceTransfer_Delete_Result

(no fields)

data FailedForceTransfer_Delete_Result

Result of FailedForceTransfer_Delete.

FailedForceTransfer_Delete_Result

(no fields)

data ForceTransfer

Force transfer payload.

ForceTransfer

Field	Type	Description
requestor	Party	Party requesting the force transfer.
requestorRationale	Text	Requestor rationale for the force transfer.
transfer	Transfer	Transfer payload.
senderLabel	Text	Label of the holding to transfer.
receiverLabel	Text	Label of the holding to receive.

data ForceTransferRequest_Accept_Result

Result of ForceTransferRequest_Accept.

ForceTransferRequest_Accept_Result

Field	Type	Description
acceptedForceTransferCid	ContractId AcceptedForceTransfer	Accepted force transfer.

data ForceTransferRequest_Cancel_Result

Result of ForceTransferRequest_Cancel.

ForceTransferRequest_Cancel_Result

(no fields)

data ForceTransferRequest_Reject_Result

Result of ForceTransferRequest_Reject.

ForceTransferRequest_Reject_Result

Field	Type	Description
rejectedForceTransferCid	ContractId RejectedForceTransfer	Rejected force transfer request.

data RejectedForceTransfer_Delete_Result

Result of RejectedForceTransfer_Delete.

RejectedForceTransfer_Delete_Result

(no fields)

Functions

prepareHoldingWithAmount

: Decimal -> [ContractId Holding] -> Update (ContractId Holding, [ContractId Holding])

Prepare holdings to meet the target amount.