backbone-banking 0.9.0

Cash & bank — bank/account master, statement import, reconciliation, and clearing postings (5th GL producer)
Documentation
//! Repository trait for BankStatementImport aggregate
//!
//! Generated by metaphor-schema. Do not edit manually.
//!
//! This trait defines the repository contract for the BankStatementImport aggregate.
//! Implementation is in the infrastructure layer.

use async_trait::async_trait;
use anyhow::Result;
use uuid::Uuid;

use crate::domain::entity::{BankStatementImport, ImportStatus, SourceFormat};

/// Pagination parameters for list queries
#[derive(Debug, Clone, Default)]
pub struct BankStatementImportPaginationParams {
    pub page: u32,
    pub per_page: u32,
}

impl BankStatementImportPaginationParams {
    pub fn new(page: u32, per_page: u32) -> Self {
        Self { page, per_page }
    }

    pub fn offset(&self) -> u64 {
        ((self.page.saturating_sub(1)) * self.per_page) as u64
    }

    pub fn limit(&self) -> u64 {
        self.per_page as u64
    }
}

/// Paginated result for list queries
#[derive(Debug, Clone)]
pub struct BankStatementImportPaginatedResult {
    pub data: Vec<BankStatementImport>,
    pub total: u64,
    pub page: u32,
    pub per_page: u32,
}

/// Filter parameters for list queries
#[derive(Debug, Clone, Default)]
pub struct BankStatementImportFilter {
    pub bank_account_id: Option<Uuid>,
    pub source_format: Option<SourceFormat>,
    pub file_ref: Option<String>,
    pub status: Option<ImportStatus>,
}

impl BankStatementImportFilter {
    /// Check if any filter is set
    pub fn has_filters(&self) -> bool {
        self.bank_account_id.is_some() || self.source_format.is_some() || self.file_ref.is_some() || self.status.is_some()
    }
}

/// Repository trait for BankStatementImport aggregate
///
/// This trait defines the persistence contract for BankStatementImport entities.
/// Implementations should be in the infrastructure layer.
#[async_trait]
pub trait BankStatementImportRepository: Send + Sync {

    // =========================================================================
    // Core CRUD Operations
    // =========================================================================

    /// Save a new bank_statement_import entity
    async fn save(&self, entity: &BankStatementImport) -> Result<BankStatementImport>;

    /// Find bank_statement_import by ID
    async fn find_by_id(&self, id: &str) -> Result<Option<BankStatementImport>>;

    /// Find all bank_statement_import entities
    async fn find_all(&self) -> Result<Vec<BankStatementImport>>;

    /// Update bank_statement_import by ID
    async fn update(&self, id: &str, entity: &BankStatementImport) -> Result<Option<BankStatementImport>>;

    /// Delete bank_statement_import by ID
    async fn delete(&self, id: &str) -> Result<bool>;

    // =========================================================================
    // Pagination
    // =========================================================================

    /// List bank_statement_import with pagination
    async fn list(&self, params: BankStatementImportPaginationParams) -> Result<BankStatementImportPaginatedResult>;

    /// List bank_statement_import with pagination and filters
    async fn list_with_filters(&self, params: BankStatementImportPaginationParams, filters: BankStatementImportFilter) -> Result<BankStatementImportPaginatedResult>;

    /// Count all bank_statement_import entities
    async fn count(&self) -> Result<u64>;

    /// Count bank_statement_import entities matching filters
    async fn count_with_filters(&self, filters: BankStatementImportFilter) -> Result<u64>;

    /// Check if bank_statement_import exists by ID
    async fn exists(&self, id: &str) -> Result<bool>;

    // =========================================================================
    // Soft Delete Operations
    // =========================================================================

    /// Soft delete bank_statement_import by ID
    async fn soft_delete(&self, id: &str) -> Result<bool>;

    /// Restore soft-deleted bank_statement_import by ID
    async fn restore(&self, id: &str) -> Result<Option<BankStatementImport>>;

    /// List soft-deleted bank_statement_import entities
    async fn list_deleted(&self, params: BankStatementImportPaginationParams) -> Result<BankStatementImportPaginatedResult>;

    /// Empty trash (permanently delete all soft-deleted entities)
    async fn empty_trash(&self) -> Result<u64>;

    // =========================================================================
    // Bulk Operations
    // =========================================================================

    /// Bulk save bank_statement_import entities
    async fn bulk_save(&self, entities: &[BankStatementImport]) -> Result<Vec<BankStatementImport>>;

    /// Bulk delete by IDs
    async fn bulk_delete(&self, ids: &[&str]) -> Result<u64>;
}