AFF for Lock Objects (ENQU)

file-formats/enqu/README.md

@@ -0,0 +1,13 @@
+# Lock Object File Format
+
+## Object Type Information
+
+Object Type | Description | Group
+:--- | :--- | :---
+ENQU | Lock Object | Dictionary
+
+## File Structure
+
+File | Cardinality | Definition | Schema | Example
+:--- | :---  | :--- | :--- | :---
+`<name>.enqu.json` | 1 | [`zif_aff_enqu_v1.intf.abap`](./type/zif_aff_enqu_v1.intf.abap) | [`enqu-v1.json`](./enqu-v1.json) | [`z_aff_example_enqu.enqu.json`](./examples/z_aff_example_enqu.enqu.json)

file-formats/enqu/enqu-v1.json

@@ -0,0 +1,258 @@
+{
+  "$comment": "This file is autogenerated, do not edit manually, see https://github.com/SAP/abap-file-formats for more information.",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/SAP/abap-file-formats/blob/main/file-formats/enqu/enqu-v1.json",
+  "title": "Lock Object",
+  "description": "Lock Object (ENQU) v1",
+  "type": "object",
+  "properties": {
+    "formatVersion": {
+      "title": "Format Version",
+      "description": "Format version",
+      "type": "string",
+      "const": "1"
+    },
+    "header": {
+      "title": "Header",
+      "description": "Header",
+      "type": "object",
+      "properties": {
+        "description": {
+          "title": "Description",
+          "description": "Description of the ABAP object",
+          "type": "string",
+          "maxLength": 60
+        },
+        "originalLanguage": {
+          "title": "Original Language",
+          "description": "Original language of the ABAP object",
+          "type": "string",
+          "minLength": 2
+        },
+        "abapLanguageVersion": {
+          "title": "ABAP Language Version",
+          "description": "ABAP language version",
+          "type": "string",
+          "enum": [
+            "standard",
+            "keyUser",
+            "cloudDevelopment"
+          ],
+          "enumTitles": [
+            "Standard",
+            "ABAP for Key Users",
+            "ABAP Cloud Development"
+          ],
+          "enumDescriptions": [
+            "Standard",
+            "ABAP for key user extensibility",
+            "ABAP cloud development"
+          ],
+          "default": "standard"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "description",
+        "originalLanguage"
+      ]
+    },
+    "primaryTable": {
+      "title": "Primary Table",
+      "description": "Primary Table of the lock object",
+      "type": "object",
+      "properties": {
+        "primaryTable": {
+          "title": "Table",
+          "description": "Table",
+          "type": "string",
+          "maxLength": 30
+        },
+        "lockMode": {
+          "title": "Lock Mode",
+          "description": "Lock Mode",
+          "type": "string",
+          "enum": [
+            "exclusiveLock",
+            "sharedLock",
+            "exclusiveNotCumulativeLock",
+            "setOptimisticLock",
+            "promoteOptimisticLock",
+            "conflictCheckExtendedExcl",
+            "conflictCheckExclusiveLock",
+            "conflictCheckSharedLock",
+            "promotionCheckOptimizedLock",
+            "reserved1",
+            "reserved2"
+          ],
+          "enumTitles": [
+            "Exclusive Lock",
+            "Shared lock",
+            "Exclusive, not cumulative",
+            "Set optimistic lock",
+            "Promote optimistic lock; transform from '0' to 'E'",
+            "Only conflict check extended exclusive lock, as with 'X'",
+            "Only conflict check exclusive lock, as with 'E'",
+            "Conflict check for shared lock only, as with 'S'",
+            "Only promotion check optimized lock, as with 'R'",
+            "Reserved",
+            "Reserved"
+          ],
+          "enumDescriptions": [
+            "Exclusive Lock",
+            "Shared lock",
+            "Exclusive, not cumulative",
+            "Set optimistic lock",
+            "Promote optimistic lock; transform from '0' to 'E'",
+            "Only conflict check extended exclusive lock, as with 'X'",
+            "Only conflict check exclusive lock, as with 'E'",
+            "CaConflict check for shared lock only, as with 'S'",
+            "Only promotion check optimized lock, as with 'R'",
+            "Reserved",
+            "Reserved"
+          ],
+          "default": "exclusiveLock"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "primaryTable",
+        "lockMode"
+      ]
+    },
+    "lockModules": {
+      "title": "Lock Modules",
+      "description": "The lock modules are generated on activation",
+      "type": "object",
+      "properties": {
+        "allowRfc": {
+          "title": "Allow RFC",
+          "description": "Allow RFC",
+          "type": "boolean"
+        },
+        "lockModule": {
+          "title": "Lock Module",
+          "description": "Lock Module",
+          "type": "string",
+          "maxLength": 30
+        },
+        "unlockModule": {
+          "title": "Unlock Module",
+          "description": "Unlock Module",
+          "type": "string",
+          "maxLength": 30
+        }
+      },
+      "additionalProperties": false
+    },
+    "secondaryTables": {
+      "title": "Secondary Tables",
+      "description": "Secondary Tables must have a foreign key relation to the primary table",
+      "type": "array",
+      "items": {
+        "title": "Primary Table",
+        "description": "Primary Table of the lock object",
+        "type": "object",
+        "properties": {
+          "primaryTable": {
+            "title": "Table",
+            "description": "Table",
+            "type": "string",
+            "maxLength": 30
+          },
+          "lockMode": {
+            "title": "Lock Mode",
+            "description": "Lock Mode",
+            "type": "string",
+            "enum": [
+              "exclusiveLock",
+              "sharedLock",
+              "exclusiveNotCumulativeLock",
+              "setOptimisticLock",
+              "promoteOptimisticLock",
+              "conflictCheckExtendedExcl",
+              "conflictCheckExclusiveLock",
+              "conflictCheckSharedLock",
+              "promotionCheckOptimizedLock",
+              "reserved1",
+              "reserved2"
+            ],
+            "enumTitles": [
+              "Exclusive Lock",
+              "Shared lock",
+              "Exclusive, not cumulative",
+              "Set optimistic lock",
+              "Promote optimistic lock; transform from '0' to 'E'",
+              "Only conflict check extended exclusive lock, as with 'X'",
+              "Only conflict check exclusive lock, as with 'E'",
+              "Conflict check for shared lock only, as with 'S'",
+              "Only promotion check optimized lock, as with 'R'",
+              "Reserved",
+              "Reserved"
+            ],
+            "enumDescriptions": [
+              "Exclusive Lock",
+              "Shared lock",
+              "Exclusive, not cumulative",
+              "Set optimistic lock",
+              "Promote optimistic lock; transform from '0' to 'E'",
+              "Only conflict check extended exclusive lock, as with 'X'",
+              "Only conflict check exclusive lock, as with 'E'",
+              "CaConflict check for shared lock only, as with 'S'",
+              "Only promotion check optimized lock, as with 'R'",
+              "Reserved",
+              "Reserved"
+            ],
+            "default": "exclusiveLock"
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "primaryTable",
+          "lockMode"
+        ]
+      }
+    },
+    "lockParameters": {
+      "title": "Lock Parameters",
+      "description": "Lock parameter candidates are derived from the primary keys of the tables",
+      "type": "array",
+      "items": {
+        "title": "Lock Parameter",
+        "description": "Lock Parameter",
+        "type": "object",
+        "properties": {
+          "active": {
+            "title": "Active",
+            "description": "Parameter is part of Function Module Interface",
+            "type": "boolean"
+          },
+          "parameterName": {
+            "title": "Parameter Name",
+            "description": "Parameter_name",
+            "type": "string",
+            "maxLength": 30
+          },
+          "table": {
+            "title": "Table",
+            "description": "Table",
+            "type": "string",
+            "maxLength": 30
+          },
+          "field": {
+            "title": "Field",
+            "description": "Field",
+            "type": "string",
+            "maxLength": 30
+          }
+        },
+        "additionalProperties": false
+      }
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "formatVersion",
+    "header"
+  ]
+}

file-formats/enqu/examples/z_aff_example_enqu.enqu.json

@@ -0,0 +1,40 @@
+{
+  "header": {
+    "description": "Example Lock Object",
+    "originalLanguage": "DE",
+    "abapLanguageVersion": "standard"
+  },
+  "primaryTable": {
+    "primaryTable": "ZTEST_TABLE",
+    "lockMode": "exclusiveLock"
+  },
+  "lockModules": {
+    "allowRfc": true,
+    "lockModule": "ZTEST_TABLE_ENQUEUE",
+    "unlockModule": "ZTEST_TABLE_DEQUEUE"
+  },
+  "secondaryTables": [
+    {
+      "primaryTable": "ZTEST_SUBTAB",
+      "lockMode": "exclusiveLock"
+    },
+    {
+      "primaryTable": "ZTEST_SUBTAB2",
+      "lockMode": "sharedLock"
+    }
+  ],
+  "lockParameters": [
+    {
+      "active": true,
+      "parameterName": "FIELD1",
+      "table": "ZTEST_TABLE",
+      "field": "Field1"
+    },
+    {
+      "active": false,
+      "parameterName": "FIELD2",
+      "table": "ZTEST_SUBTAB",
+      "field": "FIELD2"
+    }
+  ]
+}