Interface SpreadServiceLocal


public interface SpreadServiceLocal
Local interface for managing spreads.

This interface defines methods for creating queries, retrieving, creating, updating, and deleting spreads. It provides a contract for interacting with spread entities.

See Also:
  • Method Details

    • createSpreadQuery

      SpreadQuery createSpreadQuery()
      Creates a new SpreadQuery for querying spreads.
      Returns:
      a new SpreadQuery instance
    • getSpreadById

      Optional<Spread> getSpreadById(SpreadId spreadId)
      Retrieves a SpreadQuery by its unique identifier.
      Parameters:
      spreadId - the identifier of the spread to retrieve
      Returns:
      an Optional containing the Spread if found, or an empty Optional if not
    • getSpreadsByDocumentId

      List<Spread> getSpreadsByDocumentId(DocumentId documentId)
      Retrieves a list of Spread objects associated with a specific document.
      Parameters:
      documentId - the identifier of the document for which to retrieve the spreads
      Returns:
      a List of Spread objects associated with the specified document, or an empty List if no spreads are found
    • getSpreadPreview

      default Optional<SpreadPreview> getSpreadPreview(SpreadId spreadId)
      Retrieves a preview of a specific Spread within a Document.
      Parameters:
      spreadId - the identifier of the Spread to preview
      Returns:
      a SpreadPreview instance containing preview data of the specified Spread