.. _module-utility-registry-app-v0-service-enforcement-87663:

Utility.Registry.App.V0.Service.Enforcement
===========================================

This module is available starting from version ``0.1.0`` of this package\.

Templates
---------

.. _type-utility-registry-app-v0-service-enforcement-enforcementservice-39236:

**template** `EnforcementService <type-utility-registry-app-v0-service-enforcement-enforcementservice-39236_>`_

  A service for managing enforcement relationships, granting the registrar the authority to
  enforce actions like transfers between holders\.

  Signatory\: provider, registrar, holder

  .. 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>`_
       - Service operator\.
     * - provider
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - Service provider\.
     * - registrar
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - Service registrar\.
     * - holder
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - Service holder\.

  + **Choice** Archive

    Controller\: provider, registrar, holder

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-app-v0-service-enforcement-enforcementserviceacceptforcetransferrequest-25177:

    **Choice** `EnforcementService_AcceptForceTransferRequest <type-utility-registry-app-v0-service-enforcement-enforcementserviceacceptforcetransferrequest-25177_>`_

    Accepts a force transfer request\.

    Controller\: registrar

    Returns\: `ForceTransferRequest_Accept_Result <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/registry-model/Utility-Registry-V0-Holding-ForceTransfer.html#type-utility-registry-v0-holding-forcetransfer-forcetransferrequestacceptresult-18066>`_

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

       * - Field
         - Type
         - Description
       * - cid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `ForceTransferRequest <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/registry-model/Utility-Registry-V0-Holding-ForceTransfer.html#type-utility-registry-v0-holding-forcetransfer-forcetransferrequest-23761>`_
         - Force transfer request\.
       * - payload
         - `ForceTransferRequest_Accept <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/registry-model/Utility-Registry-V0-Holding-ForceTransfer.html#type-utility-registry-v0-holding-forcetransfer-forcetransferrequestaccept-60537>`_
         - Choice payload\.
       * - receiverEnforcementServiceCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `EnforcementService <type-utility-registry-app-v0-service-enforcement-enforcementservice-39236_>`_
         - Receiver enforcement service\.

  + .. _type-utility-registry-app-v0-service-enforcement-enforcementserviceacceptforcetransferrequestwithsenderauthorization-41316:

    **Choice** `EnforcementService_AcceptForceTransferRequestWithSenderAuthorization <type-utility-registry-app-v0-service-enforcement-enforcementserviceacceptforcetransferrequestwithsenderauthorization-41316_>`_

    Accepts a force\-transfer request with sender authorization\.

    Controller\: provider, registrar, sender

    Returns\: `ForceTransferRequest_Accept_Result <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/registry-model/Utility-Registry-V0-Holding-ForceTransfer.html#type-utility-registry-v0-holding-forcetransfer-forcetransferrequestacceptresult-18066>`_

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

       * - Field
         - Type
         - Description
       * - cid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `ForceTransferRequest <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/registry-model/Utility-Registry-V0-Holding-ForceTransfer.html#type-utility-registry-v0-holding-forcetransfer-forcetransferrequest-23761>`_
         - Force transfer request to accept\.
       * - payload
         - `ForceTransferRequest_Accept <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/registry-model/Utility-Registry-V0-Holding-ForceTransfer.html#type-utility-registry-v0-holding-forcetransfer-forcetransferrequestaccept-60537>`_
         - Choice payload\.
       * - sender
         - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
         - Sender of the transfer to force accept\.

  + .. _type-utility-registry-app-v0-service-enforcement-enforcementserviceterminate-98334:

    **Choice** `EnforcementService_Terminate <type-utility-registry-app-v0-service-enforcement-enforcementserviceterminate-98334_>`_

    Terminates the service\.

    Controller\: registrar

    Returns\: `EnforcementService_Terminate_Result <type-utility-registry-app-v0-service-enforcement-enforcementserviceterminateresult-51955_>`_

    (no fields)

.. _type-utility-registry-app-v0-service-enforcement-enforcementservicerequest-95006:

**template** `EnforcementServiceRequest <type-utility-registry-app-v0-service-enforcement-enforcementservicerequest-95006_>`_

  A enforcement service request\.

  Signatory\: holder

  .. 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>`_
       - Service operator\.
     * - provider
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - Service provider of the registrar\.
     * - registrar
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - Service registrar\.
     * - holder
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - Service holder\.

  + **Choice** Archive

    Controller\: holder

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-app-v0-service-enforcement-enforcementservicerequestaccept-17172:

    **Choice** `EnforcementServiceRequest_Accept <type-utility-registry-app-v0-service-enforcement-enforcementservicerequestaccept-17172_>`_

    Accept request\.

    Controller\: provider, registrar

    Returns\: `EnforcementServiceRequest_Accept_Result <type-utility-registry-app-v0-service-enforcement-enforcementservicerequestacceptresult-95885_>`_

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

       * - Field
         - Type
         - Description
       * - registrarConfigurationCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ :ref:`RegistrarConfiguration <type-utility-registry-app-v0-configuration-registrar-registrarconfiguration-39222>`
         - Registrar 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 credentials\.

  + .. _type-utility-registry-app-v0-service-enforcement-enforcementservicerequestcancel-25266:

    **Choice** `EnforcementServiceRequest_Cancel <type-utility-registry-app-v0-service-enforcement-enforcementservicerequestcancel-25266_>`_

    Cancel request\.

    Controller\: holder

    Returns\: `EnforcementServiceRequest_Cancel_Result <type-utility-registry-app-v0-service-enforcement-enforcementservicerequestcancelresult-79151_>`_

    (no fields)

  + .. _type-utility-registry-app-v0-service-enforcement-enforcementservicerequestreject-28333:

    **Choice** `EnforcementServiceRequest_Reject <type-utility-registry-app-v0-service-enforcement-enforcementservicerequestreject-28333_>`_

    Reject request\.

    Controller\: provider, registrar

    Returns\: `EnforcementServiceRequest_Reject_Result <type-utility-registry-app-v0-service-enforcement-enforcementservicerequestrejectresult-70650_>`_

    .. 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>`_
         - Rejection reason\.

.. _type-utility-registry-app-v0-service-enforcement-rejectedenforcementservicerequest-22332:

**template** `RejectedEnforcementServiceRequest <type-utility-registry-app-v0-service-enforcement-rejectedenforcementservicerequest-22332_>`_

  A rejected enforcement service request\.

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

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

     * - Field
       - Type
       - Description
     * - request
       - `EnforcementServiceRequest <type-utility-registry-app-v0-service-enforcement-enforcementservicerequest-95006_>`_
       - The rejected request payload\.
     * - reason
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - The rejection reason\.

  + **Choice** Archive

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

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-app-v0-service-enforcement-rejectedenforcementservicerequestdelete-70771:

    **Choice** `RejectedEnforcementServiceRequest_Delete <type-utility-registry-app-v0-service-enforcement-rejectedenforcementservicerequestdelete-70771_>`_

    Deletes a rejected enforcement service request\.

    Controller\: (DA\.Internal\.Record\.getField @\"provider\" request)

    Returns\: `RejectedEnforcementServiceRequest_Delete_Result <type-utility-registry-app-v0-service-enforcement-rejectedenforcementservicerequestdeleteresult-80284_>`_

    (no fields)

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

.. _type-utility-registry-app-v0-service-enforcement-enforcementservicerequestacceptresult-95885:

**data** `EnforcementServiceRequest_Accept_Result <type-utility-registry-app-v0-service-enforcement-enforcementservicerequestacceptresult-95885_>`_

  Result of ``EnforcementServiceRequest_Accept``\.

  .. _constr-utility-registry-app-v0-service-enforcement-enforcementservicerequestacceptresult-23090:

  `EnforcementServiceRequest_Accept_Result <constr-utility-registry-app-v0-service-enforcement-enforcementservicerequestacceptresult-23090_>`_

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

       * - Field
         - Type
         - Description
       * - enforcementServiceCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `EnforcementService <type-utility-registry-app-v0-service-enforcement-enforcementservice-39236_>`_
         - Enforcement service\.

.. _type-utility-registry-app-v0-service-enforcement-enforcementservicerequestcancelresult-79151:

**data** `EnforcementServiceRequest_Cancel_Result <type-utility-registry-app-v0-service-enforcement-enforcementservicerequestcancelresult-79151_>`_

  Result of ``EnforcementServiceRequest_Cancel``\.

  .. _constr-utility-registry-app-v0-service-enforcement-enforcementservicerequestcancelresult-69168:

  `EnforcementServiceRequest_Cancel_Result <constr-utility-registry-app-v0-service-enforcement-enforcementservicerequestcancelresult-69168_>`_

    (no fields)

.. _type-utility-registry-app-v0-service-enforcement-enforcementservicerequestrejectresult-70650:

**data** `EnforcementServiceRequest_Reject_Result <type-utility-registry-app-v0-service-enforcement-enforcementservicerequestrejectresult-70650_>`_

  Result of ``EnforcementServiceRequest_Reject``\.

  .. _constr-utility-registry-app-v0-service-enforcement-enforcementservicerequestrejectresult-36585:

  `EnforcementServiceRequest_Reject_Result <constr-utility-registry-app-v0-service-enforcement-enforcementservicerequestrejectresult-36585_>`_

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

       * - Field
         - Type
         - Description
       * - rejectedEnforcementServiceRequestCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `RejectedEnforcementServiceRequest <type-utility-registry-app-v0-service-enforcement-rejectedenforcementservicerequest-22332_>`_
         - Rejected enforcement service request\.

.. _type-utility-registry-app-v0-service-enforcement-enforcementserviceterminateresult-51955:

**data** `EnforcementService_Terminate_Result <type-utility-registry-app-v0-service-enforcement-enforcementserviceterminateresult-51955_>`_

  Result of ``EnforcementService_Terminate``\.

  .. _constr-utility-registry-app-v0-service-enforcement-enforcementserviceterminateresult-50348:

  `EnforcementService_Terminate_Result <constr-utility-registry-app-v0-service-enforcement-enforcementserviceterminateresult-50348_>`_

    (no fields)

.. _type-utility-registry-app-v0-service-enforcement-rejectedenforcementservicerequestdeleteresult-80284:

**data** `RejectedEnforcementServiceRequest_Delete_Result <type-utility-registry-app-v0-service-enforcement-rejectedenforcementservicerequestdeleteresult-80284_>`_

  Result of ``RejectedEnforcementServiceRequest_Delete``\.

  .. _constr-utility-registry-app-v0-service-enforcement-rejectedenforcementservicerequestdeleteresult-46255:

  `RejectedEnforcementServiceRequest_Delete_Result <constr-utility-registry-app-v0-service-enforcement-rejectedenforcementservicerequestdeleteresult-46255_>`_

    (no fields)