The CeReport annotation is used exclusively for reports to define how and where the report results should be displayed. It specifies whether the output should be automatically generated or custom-rendered, as well as the data processing method (entity-based or cursor-based).

How Reports Are Processed?

1️⃣ Standard Reports (GeneratorType.Report)

• The report returns a Flow<List<resultExtEntity>>.
• The resultUI component automatically handles the output.

2️⃣ Cursor-Based Reports (GeneratorType.ReportCursor)

• The report returns a Cursor, which can be processed in resultUI.
• The cursor output can be automatically generated or manually rendered using the function specified in onResult.

Annotation Parameters:

📋 Report Data Structure

• resultEntity: KClass<*> (Required)
  • The entity that receives the query result.
• resultExtEntity: KClass<*> (Default: Nothing::class)
  • An extended entity with related fields for a more comprehensive report structure.

🖥️ UI and Display Options

• resultUI: KClass<*> (Default: Nothing::class)
  • The UI component responsible for rendering the report output.
  • If not specified, the system assumes it is named {resultEntity}UI.
• standardOutput: Boolean (Default: true)
  • If true, the report is automatically generated.
  • If false, a custom rendering function (onResult) must be provided.

📊 Query Configuration

• query: String (Default: "")
  • The main query body without conditions or grouping.
• groups: String (Default: "")
  • Grouping fields (comma-separated) without "GROUP BY" keyword.