Package ai.extend.types

Class EditJsonSchema

  • public final class EditJsonSchema
extends java.lang.Object

    • Method Detail

      • getType

        public java.util.Optional<java.lang.Object> getType()
        Returns:
        The JSON schema type of the field. Can be:
        • A string: "array" or "object"
        • A nullable tuple array: ["string", "null"], ["number", "null"], ["integer", "null"], ["boolean", "null"]
        • Omitted for enum fields (use enum property instead)

      • getDescription

        public java.util.Optional<java.lang.String> getDescription()
        Returns:
        Description of the field

      • getExtendEditFieldType

        public java.util.Optional<EditJsonSchemaExtendEditFieldType> getExtendEditFieldType()
        Returns:
        The PDF field type to edit. Allowed values depend on the schema type:
        • ["string", "null"] → text, signature
        • ["number", "null"] → text
        • ["integer", "null"] → text
        • ["boolean", "null"] → checkbox, radio
        • "array" → text, table
        • "object" → signature
        • enum fields (no type) → radio, optionList, dropdown

      • getExtendEditBbox

        public java.util.Optional<EditBoundingBox> getExtendEditBbox()

      • getExtendEditBboxes

        public java.util.Optional<java.util.List<EditBoundingBox>> getExtendEditBboxes()
        Returns:
        Array of bounding boxes for radio enums. Enum at index i corresponds to bbox at index i.

      • getExtendEditPageIndex

        public java.util.Optional<java.lang.Integer> getExtendEditPageIndex()
        Returns:
        Zero-based page index where the field should be placed

      • getExtendEditTextEditOptions

        public java.util.Optional<EditTextOptions> getExtendEditTextEditOptions()

      • getExtendEditColumnWidth

        public java.util.Optional<java.lang.Double> getExtendEditColumnWidth()
        Returns:
        Width of the column as a percentage (for table fields)

      • getExtendEditValue

        public java.util.Optional<java.lang.Object> getExtendEditValue()
        Returns:
        The value to fill into this field. Can be any type. This will force the value at this field to be filled with this value. If a value is not provided, we will attempt to generate or infer one based on the instructions.

      • getExtendEditRowHeights

        public java.util.Optional<java.util.List<java.lang.Double>> getExtendEditRowHeights()
        Returns:
        Array of row height percentages for array/table fields (e.g. [0.25, 0.50, 0.25])

      • getItems

        public java.util.Optional<EditObjectJsonSchema> getItems()
        Returns:
        Schema for array items (when type is "array"). Must be an EditObjectJSONSchema.

      • getProperties

        public java.util.Optional<java.util.Map<java.lang.String,​EditJsonSchema>> getProperties()
        Returns:
        Nested properties for object types. Each property follows the EditJSONSchema structure.

      • getEnum

        public java.util.Optional<java.util.List<java.lang.String>> getEnum()
        Returns:
        Allowed values for enum/dropdown/radio fields

      • getMaxItems

        public java.util.Optional<java.lang.Integer> getMaxItems()
        Returns:
        Maximum number of rows for array/table fields

      • getRequired

        public java.util.Optional<java.util.List<java.lang.String>> getRequired()
        Returns:
        List of required property names (for object types)

      • getAdditionalProperties

        public java.util.Optional<java.lang.Boolean> getAdditionalProperties()
        Returns:
        Whether additional properties are allowed (for object types)

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • _getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> _getAdditionalProperties()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object