.. _module-utility-registry-v0-holding-lock-63020:

Utility.Registry.V0.Holding.Lock
================================

Templates
---------

.. _type-utility-registry-v0-holding-lock-acceptedlock-69316:

**template** `AcceptedLock <type-utility-registry-v0-holding-lock-acceptedlock-69316_>`_

  An accepted lock\.

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

  .. list-table::
     :widths: 15 10 30
     :header-rows: 1

     * - Field
       - Type
       - Description
     * - lock
       - `Lock <type-utility-registry-v0-holding-lock-lock-7055_>`_
       - Accepted lock payload\.
     * - holdingLabel
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Label of the holding to lock\.

  + .. _type-utility-registry-v0-holding-lock-acceptedlockexecute-88124:

    **Choice** `AcceptedLock_Execute <type-utility-registry-v0-holding-lock-acceptedlockexecute-88124_>`_

    Execute an accepted lock\.

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

    Returns\: `AcceptedLock_Execute_Result <type-utility-registry-v0-holding-lock-acceptedlockexecuteresult-31301_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - instrumentConfigurationCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ :ref:`InstrumentConfiguration <type-utility-registry-v0-configuration-instrument-instrumentconfiguration-39219>`
         - Instrument configuration\.
       * - credentialCids
         - \[`ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `Credential <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/credential-model/Utility-Credential-V0-Credential.html#type-utility-credential-v0-credential-credential-66032>`_\]
         - Holder credential cids\.
       * - holdingCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `Holding <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/registry-holding-model/Utility-Registry-Holding-V0-Holding.html#type-utility-registry-holding-v0-holding-holding-15575>`_
         - Holding to lock\.

  + .. _type-utility-registry-v0-holding-lock-acceptedlockfail-16204:

    **Choice** `AcceptedLock_Fail <type-utility-registry-v0-holding-lock-acceptedlockfail-16204_>`_

    Fail an accepted lock\.

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

    Returns\: `AcceptedLock_Fail_Result <type-utility-registry-v0-holding-lock-acceptedlockfailresult-40253_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - reason
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Reason for failure\.

  + **Choice** Archive

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

    Returns\: ()

    (no fields)

.. _type-utility-registry-v0-holding-lock-executedlock-45120:

**template** `ExecutedLock <type-utility-registry-v0-holding-lock-executedlock-45120_>`_

  An executed lock\.

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

  .. list-table::
     :widths: 15 10 30
     :header-rows: 1

     * - Field
       - Type
       - Description
     * - lock
       - `Lock <type-utility-registry-v0-holding-lock-lock-7055_>`_
       - Lock payload\.
     * - holdingLabel
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Label of the holding to lock\.

  + **Choice** Archive

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

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-v0-holding-lock-executedlockdelete-12455:

    **Choice** `ExecutedLock_Delete <type-utility-registry-v0-holding-lock-executedlockdelete-12455_>`_

    Deletes an executed lock\.

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

    Returns\: `ExecutedLock_Delete_Result <type-utility-registry-v0-holding-lock-executedlockdeleteresult-1328_>`_

    (no fields)

.. _type-utility-registry-v0-holding-lock-failedlock-33806:

**template** `FailedLock <type-utility-registry-v0-holding-lock-failedlock-33806_>`_

  A failed lock\.

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

  .. list-table::
     :widths: 15 10 30
     :header-rows: 1

     * - Field
       - Type
       - Description
     * - lock
       - `Lock <type-utility-registry-v0-holding-lock-lock-7055_>`_
       - Rejected lock payload\.
     * - reason
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Reason for failure\.

  + **Choice** Archive

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

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-v0-holding-lock-failedlockdelete-17625:

    **Choice** `FailedLock_Delete <type-utility-registry-v0-holding-lock-failedlockdelete-17625_>`_

    Deletes a rejected lock\.

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

    Returns\: `FailedLock_Delete_Result <type-utility-registry-v0-holding-lock-failedlockdeleteresult-53378_>`_

    (no fields)

.. _type-utility-registry-v0-holding-lock-lockoffer-96600:

**template** `LockOffer <type-utility-registry-v0-holding-lock-lockoffer-96600_>`_

  An offer to lock a holding

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

  .. list-table::
     :widths: 15 10 30
     :header-rows: 1

     * - Field
       - Type
       - Description
     * - lock
       - `Lock <type-utility-registry-v0-holding-lock-lock-7055_>`_
       - Lock offer payload\.
     * - holdingLabel
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Label of the holding to lock\.

  + **Choice** Archive

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

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-v0-holding-lock-lockofferaccept-77806:

    **Choice** `LockOffer_Accept <type-utility-registry-v0-holding-lock-lockofferaccept-77806_>`_

    Accepts a lock offer\.

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

    Returns\: `LockOffer_Accept_Result <type-utility-registry-v0-holding-lock-lockofferacceptresult-80403_>`_

    (no fields)

  + .. _type-utility-registry-v0-holding-lock-lockoffercancel-86952:

    **Choice** `LockOffer_Cancel <type-utility-registry-v0-holding-lock-lockoffercancel-86952_>`_

    Cancels a lock offer\.

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

    Returns\: `LockOffer_Cancel_Result <type-utility-registry-v0-holding-lock-lockoffercancelresult-28473_>`_

    (no fields)

  + .. _type-utility-registry-v0-holding-lock-lockofferreject-22627:

    **Choice** `LockOffer_Reject <type-utility-registry-v0-holding-lock-lockofferreject-22627_>`_

    Rejects a lock offer\.

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

    Returns\: `LockOffer_Reject_Result <type-utility-registry-v0-holding-lock-lockofferrejectresult-23324_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - reason
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Reason for rejection\.

.. _type-utility-registry-v0-holding-lock-lockrequest-27191:

**template** `LockRequest <type-utility-registry-v0-holding-lock-lockrequest-27191_>`_

  A request to lock a holding

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

  .. list-table::
     :widths: 15 10 30
     :header-rows: 1

     * - Field
       - Type
       - Description
     * - lock
       - `Lock <type-utility-registry-v0-holding-lock-lock-7055_>`_
       - Lock offer payload\.

  + **Choice** Archive

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

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-v0-holding-lock-lockrequestaccept-49751:

    **Choice** `LockRequest_Accept <type-utility-registry-v0-holding-lock-lockrequestaccept-49751_>`_

    Accepts a lock request\.

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

    Returns\: `LockRequest_Accept_Result <type-utility-registry-v0-holding-lock-lockrequestacceptresult-94880_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - holdingLabel
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Label of the holding to lock\.

  + .. _type-utility-registry-v0-holding-lock-lockrequestcancel-69341:

    **Choice** `LockRequest_Cancel <type-utility-registry-v0-holding-lock-lockrequestcancel-69341_>`_

    Cancels a lock request\.

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

    Returns\: `LockRequest_Cancel_Result <type-utility-registry-v0-holding-lock-lockrequestcancelresult-51362_>`_

    (no fields)

  + .. _type-utility-registry-v0-holding-lock-lockrequestreject-88182:

    **Choice** `LockRequest_Reject <type-utility-registry-v0-holding-lock-lockrequestreject-88182_>`_

    Rejects a lock request\.

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

    Returns\: `LockRequest_Reject_Result <type-utility-registry-v0-holding-lock-lockrequestrejectresult-69567_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - reason
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Reason for rejection\.

.. _type-utility-registry-v0-holding-lock-rejectedlock-57645:

**template** `RejectedLock <type-utility-registry-v0-holding-lock-rejectedlock-57645_>`_

  A rejected lock request\.

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

  .. list-table::
     :widths: 15 10 30
     :header-rows: 1

     * - Field
       - Type
       - Description
     * - lock
       - `Lock <type-utility-registry-v0-holding-lock-lock-7055_>`_
       - Rejected lock payload\.
     * - reason
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Reason for rejection\.

  + **Choice** Archive

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

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-v0-holding-lock-rejectedlockdelete-53204:

    **Choice** `RejectedLock_Delete <type-utility-registry-v0-holding-lock-rejectedlockdelete-53204_>`_

    Deletes a rejected lock\.

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

    Returns\: `RejectedLock_Delete_Result <type-utility-registry-v0-holding-lock-rejectedlockdeleteresult-873_>`_

    (no fields)

Data Types
----------

.. _type-utility-registry-v0-holding-lock-acceptedlockexecuteresult-31301:

**data** `AcceptedLock_Execute_Result <type-utility-registry-v0-holding-lock-acceptedlockexecuteresult-31301_>`_

  Result of ``AcceptedLock_Execute``\.

  .. _constr-utility-registry-v0-holding-lock-acceptedlockexecuteresult-95248:

  `AcceptedLock_Execute_Result <constr-utility-registry-v0-holding-lock-acceptedlockexecuteresult-95248_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - holdingLockResult
         - `Holding_Lock_Result <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/registry-holding-model/Utility-Registry-Holding-V0-Holding.html#type-utility-registry-holding-v0-holding-holdinglockresult-15749>`_
         - Result of acquiring the lock\.
       * - executedLockCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `ExecutedLock <type-utility-registry-v0-holding-lock-executedlock-45120_>`_
         - Executed lock\.

.. _type-utility-registry-v0-holding-lock-acceptedlockfailresult-40253:

**data** `AcceptedLock_Fail_Result <type-utility-registry-v0-holding-lock-acceptedlockfailresult-40253_>`_

  Result of ``AcceptedLock_Fail``\.

  .. _constr-utility-registry-v0-holding-lock-acceptedlockfailresult-46362:

  `AcceptedLock_Fail_Result <constr-utility-registry-v0-holding-lock-acceptedlockfailresult-46362_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - failedLockCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `FailedLock <type-utility-registry-v0-holding-lock-failedlock-33806_>`_
         - Failed lock\.

.. _type-utility-registry-v0-holding-lock-executedlockdeleteresult-1328:

**data** `ExecutedLock_Delete_Result <type-utility-registry-v0-holding-lock-executedlockdeleteresult-1328_>`_

  Result of ``ExecutedLock_Delete``\.

  .. _constr-utility-registry-v0-holding-lock-executedlockdeleteresult-76391:

  `ExecutedLock_Delete_Result <constr-utility-registry-v0-holding-lock-executedlockdeleteresult-76391_>`_

    (no fields)

.. _type-utility-registry-v0-holding-lock-failedlockdeleteresult-53378:

**data** `FailedLock_Delete_Result <type-utility-registry-v0-holding-lock-failedlockdeleteresult-53378_>`_

  Result of ``FailedLock_Delete``\.

  .. _constr-utility-registry-v0-holding-lock-failedlockdeleteresult-27029:

  `FailedLock_Delete_Result <constr-utility-registry-v0-holding-lock-failedlockdeleteresult-27029_>`_

    (no fields)

.. _type-utility-registry-v0-holding-lock-lock-7055:

**data** `Lock <type-utility-registry-v0-holding-lock-lock-7055_>`_

  Lock payload\.

  .. _constr-utility-registry-v0-holding-lock-lock-87848:

  `Lock <constr-utility-registry-v0-holding-lock-lock-87848_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - operator
         - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
         - Utility operator\.
       * - provider
         - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
         - Provider of the initiator of the lock\.
       * - registrar
         - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
         - Registrar of holding\.
       * - holder
         - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
         - Holder\.
       * - locker
         - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
         - Locker\.
       * - instrumentIdentifier
         - `InstrumentIdentifier <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/registry-holding-model/Utility-Registry-Holding-V0-Types.html#type-utility-registry-holding-v0-types-instrumentidentifier-9531>`_
         - Instrument id to lock\.
       * - amount
         - `Decimal <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-decimal-18135>`_
         - Amount to lock\.
       * - context
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Context for the lock\.
       * - reference
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Reference for the lock\.
       * - batch
         - :ref:`Batch <type-utility-registry-v0-types-batch-47769>`
         - Batch the lock belongs to\.

.. _type-utility-registry-v0-holding-lock-lockofferacceptresult-80403:

**data** `LockOffer_Accept_Result <type-utility-registry-v0-holding-lock-lockofferacceptresult-80403_>`_

  Result of ``LockOffer_Accept``\.

  .. _constr-utility-registry-v0-holding-lock-lockofferacceptresult-92974:

  `LockOffer_Accept_Result <constr-utility-registry-v0-holding-lock-lockofferacceptresult-92974_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - acceptedLockCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `AcceptedLock <type-utility-registry-v0-holding-lock-acceptedlock-69316_>`_
         - Accepted lock\.

.. _type-utility-registry-v0-holding-lock-lockoffercancelresult-28473:

**data** `LockOffer_Cancel_Result <type-utility-registry-v0-holding-lock-lockoffercancelresult-28473_>`_

  Result of ``LockOffer_Reject``\.

  .. _constr-utility-registry-v0-holding-lock-lockoffercancelresult-53364:

  `LockOffer_Cancel_Result <constr-utility-registry-v0-holding-lock-lockoffercancelresult-53364_>`_

    (no fields)

.. _type-utility-registry-v0-holding-lock-lockofferrejectresult-23324:

**data** `LockOffer_Reject_Result <type-utility-registry-v0-holding-lock-lockofferrejectresult-23324_>`_

  Result of ``LockOffer_Reject``\.

  .. _constr-utility-registry-v0-holding-lock-lockofferrejectresult-84541:

  `LockOffer_Reject_Result <constr-utility-registry-v0-holding-lock-lockofferrejectresult-84541_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - rejectedLockCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `RejectedLock <type-utility-registry-v0-holding-lock-rejectedlock-57645_>`_
         - Rejected lock\.

.. _type-utility-registry-v0-holding-lock-lockrequestacceptresult-94880:

**data** `LockRequest_Accept_Result <type-utility-registry-v0-holding-lock-lockrequestacceptresult-94880_>`_

  Result of ``LockRequest_Accept``\.

  .. _constr-utility-registry-v0-holding-lock-lockrequestacceptresult-24505:

  `LockRequest_Accept_Result <constr-utility-registry-v0-holding-lock-lockrequestacceptresult-24505_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - acceptedLockCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `AcceptedLock <type-utility-registry-v0-holding-lock-acceptedlock-69316_>`_
         - Accepted lock\.

.. _type-utility-registry-v0-holding-lock-lockrequestcancelresult-51362:

**data** `LockRequest_Cancel_Result <type-utility-registry-v0-holding-lock-lockrequestcancelresult-51362_>`_

  Result of ``LockRequest_Cancel``\.

  .. _constr-utility-registry-v0-holding-lock-lockrequestcancelresult-95275:

  `LockRequest_Cancel_Result <constr-utility-registry-v0-holding-lock-lockrequestcancelresult-95275_>`_

    (no fields)

.. _type-utility-registry-v0-holding-lock-lockrequestrejectresult-69567:

**data** `LockRequest_Reject_Result <type-utility-registry-v0-holding-lock-lockrequestrejectresult-69567_>`_

  Result of ``LockRequest_Reject``\.

  .. _constr-utility-registry-v0-holding-lock-lockrequestrejectresult-15058:

  `LockRequest_Reject_Result <constr-utility-registry-v0-holding-lock-lockrequestrejectresult-15058_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - rejectedLockCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `RejectedLock <type-utility-registry-v0-holding-lock-rejectedlock-57645_>`_
         - Rejected lock\.

.. _type-utility-registry-v0-holding-lock-rejectedlockdeleteresult-873:

**data** `RejectedLock_Delete_Result <type-utility-registry-v0-holding-lock-rejectedlockdeleteresult-873_>`_

  Result of ``RejectedLock_Delete``\.

  .. _constr-utility-registry-v0-holding-lock-rejectedlockdeleteresult-55722:

  `RejectedLock_Delete_Result <constr-utility-registry-v0-holding-lock-rejectedlockdeleteresult-55722_>`_

    (no fields)