|
| 1 | +<?php |
| 2 | + |
| 3 | +/** |
| 4 | + * Contract of BrcCrossRegisterSync |
| 5 | + * |
| 6 | + * The public surface of BrcCrossRegisterSync that other components call, so they depend |
| 7 | + * on this contract instead of the implementation. |
| 8 | + * |
| 9 | + * @category Kernel |
| 10 | + * @package OCA\Dossiq\Kernel\Contracts |
| 11 | + * @author Conduction b.v. <info@conduction.nl> |
| 12 | + * @copyright 2026 Conduction B.V. |
| 13 | + * @license EUPL-1.2 https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12 |
| 14 | + * @version GIT: <git_id> |
| 15 | + * @link https://github.com/ConductionNL/dossiq |
| 16 | + * |
| 17 | + * SPDX-FileCopyrightText: 2026 Conduction B.V. <info@conduction.nl> |
| 18 | + * SPDX-License-Identifier: EUPL-1.2 |
| 19 | + */ |
| 20 | + |
| 21 | +declare(strict_types=1); |
| 22 | + |
| 23 | +namespace OCA\Dossiq\Kernel\Contracts; |
| 24 | + |
| 25 | +/** |
| 26 | + * Contract of BrcCrossRegisterSync. |
| 27 | + * |
| 28 | + * @category Kernel |
| 29 | + * @package OCA\Dossiq\Kernel\Contracts |
| 30 | + * @author Conduction b.v. <info@conduction.nl> |
| 31 | + * @license EUPL-1.2 https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12 |
| 32 | + * @link https://github.com/ConductionNL/dossiq |
| 33 | + * |
| 34 | + * @spec exclude Structural contract, no functional requirement. |
| 35 | + */ |
| 36 | +interface BrcCrossRegisterSyncInterface { |
| 37 | + |
| 38 | + /** |
| 39 | + * Delete ObjectInformatieObjecten from DRC for a given besluit (brc-005b/009). |
| 40 | + * |
| 41 | + * @param string $decisionUrl The besluit URL to match OIOs against |
| 42 | + * |
| 43 | + * @return void |
| 44 | + * @SuppressWarnings(PHPMD.StaticAccess) ZgwSearchScope::fromMapping() is a named |
| 45 | + * constructor on a value object, not a service call. Injecting it would put a |
| 46 | + * collaborator in four controllers to answer one question about their own config. |
| 47 | + * |
| 48 | + * @spec openspec/specs/zgw-business-rules-compliance/spec.md |
| 49 | + */ |
| 50 | + public function deleteOiosForDecision(string $decisionUrl): void; |
| 51 | + |
| 52 | + /** |
| 53 | + * Sync a zaak-besluit relation to ZRC (brc-006). |
| 54 | + * |
| 55 | + * Creates a "zaakbesluit" record linking the zaak to the besluit |
| 56 | + * in the ZRC register. |
| 57 | + * |
| 58 | + * @param string $caseUrl The zaak URL |
| 59 | + * @param string $decisionUrl The besluit URL |
| 60 | + * |
| 61 | + * @return void |
| 62 | + * |
| 63 | + * @spec openspec/specs/zgw-business-rules-compliance/spec.md |
| 64 | + */ |
| 65 | + public function syncCaseDecisionToZrc(string $caseUrl, string $decisionUrl): void; |
| 66 | + |
| 67 | + /** |
| 68 | + * Create an ObjectInformatieObject in the DRC register (brc-005a). |
| 69 | + * |
| 70 | + * @param string $decisionUrl The besluit URL (full ZGW URL) |
| 71 | + * @param string $ioUrl The informatieobject URL (full ZGW URL) |
| 72 | + * |
| 73 | + * @return void |
| 74 | + * |
| 75 | + * @spec openspec/specs/zgw-business-rules-compliance/spec.md |
| 76 | + */ |
| 77 | + public function createOioInDrc(string $decisionUrl, string $ioUrl): void; |
| 78 | + |
| 79 | + /** |
| 80 | + * Delete an OIO from DRC matching a specific besluit and informatieobject (brc-005b). |
| 81 | + * |
| 82 | + * @param string $decisionUrl The besluit URL |
| 83 | + * @param string $ioUrl The informatieobject URL |
| 84 | + * |
| 85 | + * @return void |
| 86 | + * @SuppressWarnings(PHPMD.StaticAccess) ZgwSearchScope::fromMapping() is a named |
| 87 | + * constructor on a value object, not a service call. Injecting it would put a |
| 88 | + * collaborator in four controllers to answer one question about their own config. |
| 89 | + * |
| 90 | + * @spec openspec/specs/zgw-business-rules-compliance/spec.md |
| 91 | + */ |
| 92 | + public function deleteOioByDecisionAndIo(string $decisionUrl, string $ioUrl): void; |
| 93 | +}//end interface |
0 commit comments