Adds recyclebin interface

news/89.feature

@@ -0,0 +1 @@
+Adds interface for recyclebin functionality @rohnsha0

src/plone/base/interfaces/recyclebin.py

@@ -0,0 +1,127 @@
+"""Interfaces for the Plone Recycle Bin functionality."""
+
+from zope import schema
+from zope.interface import Interface
+
+
+class IRecycleBinControlPanelSettings(Interface):
+    """Interface for recycle bin settings"""
+
+    recycling_enabled = schema.Bool(
+        title="Enable the recycle bin",
+        description="Enable or disable the recycle bin feature.",
+        default=False,
+        required=False,
+    )
+
+    retention_period = schema.Int(
+        title="Retention period",
+        description="Number of days to keep deleted items in the recycle bin. Set to '0' to disable automatic purging.",
+        default=30,
+        min=0,
+    )
+
+    maximum_size = schema.Int(
+        title="Maximum size",
+        description="Maximum size of the recycle bin in MB. When the total size of items in the recycle bin exceeds its maximum size, the oldest items in the recycle bin will be permanently purged.",
+        default=100,
+        min=10,
+    )
+
+    restore_to_initial_state = schema.Bool(
+        title="Restore to initial workflow state",
+        description="When enabled, restored content will be set to its initial workflow state (usually 'draft') instead of the workflow state it was in when deleted.",
+        default=False,
+        required=False,
+    )
+
+
+class IRecycleBin(Interface):
+    """Interface for the recycle bin functionality"""
+
+    def add_item(obj, original_container, original_path):
+        """Add deleted item to recycle bin
+
+        Args:
+            obj: The object being deleted
+            original_container: The parent container before deletion
+            original_path: The full path to the object before deletion
+
+        Returns:
+            The ID of the item in the recycle bin
+        """
+
+    def get_items():
+        """Return all items in recycle bin
+
+        Returns:
+            A list of dictionaries with information about deleted items
+        """
+
+    def get_item(item_id):
+        """Get a specific deleted item by ID
+
+        Args:
+            item_id: The ID of the deleted item in the recycle bin
+
+        Returns:
+            Dictionary with item information or None if not found
+        """
+
+    def restore_item(item_id, target_container=None):
+        """Restore item to original location or specified container
+
+        Args:
+            item_id: The ID of the item in the recycle bin
+            target_container: Optional target container to restore to
+                              (defaults to original container)
+
+        Returns:
+            The restored object or None if restore failed
+        """
+
+    def purge_item(item_id):
+        """Permanently delete an item
+
+        Args:
+            item_id: The ID of the item in the recycle bin
+
+        Returns:
+            Boolean indicating success
+        """
+
+    def purge_expired_items():
+        """Purge items that exceed the retention period
+
+        Returns:
+            Number of items purged
+        """
+
+    def is_enabled():
+        """Check if recycle bin is enabled in the registry settings
+
+        Returns:
+            Boolean indicating whether recycle bin is enabled
+        """
+
+
+class IRecycleBinForm(Interface):
+    """Schema for the recycle bin form"""
+
+    selected_items = schema.List(
+        title="Selected Items",
+        description="Selected items for operations",
+        value_type=schema.TextLine(),
+        required=False,
+    )
+
+
+class IRecycleBinItemForm(Interface):
+    """Schema for the recycle bin item form"""
+
+    target_container = schema.Choice(
+        title="Target container",
+        description="Choose the container where the item should be restored when original location no longer exists",
+        vocabulary="plone.recyclebin.RestoreContainers",
+        required=False,
+    )