order-service/com.munchies.order.domain.model/Order

Order

sealed class Order : Entity<OrderId>

Represents an order in the system, which can be of different types (Delivery, Takeaway, DineIn).

Inheritors

DeliveryOrder

DineInOrder

TakeawayOrder

Types

AdvanceStatusResult

sealed interface AdvanceStatusResult

Represents the result of attempting to advance the status of an order.

CancelResult

sealed interface CancelResult

Represents the result of attempting to cancel an order.

Companion

object Companion

ItemsValidationError

enum ItemsValidationError : Enum<Order.ItemsValidationError>

Represents possible validation errors for order items.

UpdateResult

sealed interface UpdateResult

Represents the result of attempting to update the items in an order.

Properties

customerId

open val customerId: CustomerId

The unique identifier for the customer who placed the order.

open override val id: OrderId

The unique identifier for the order.

items

open val items: List<OrderItem>

The list of items included in the order.

restaurantId

open val restaurantId: RestaurantId

The unique identifier for the restaurant associated with the order.

status

open val status: OrderStatus

The current status of the order.

Functions

cancel

fun cancel(): Order.CancelResult

Cancels the order if it is in a cancellable state.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

nextStatus

abstract fun nextStatus(): Order.AdvanceStatusResult

Advances the status of the order to the next logical state.

toDocument

fun Order.toDocument(): OrderDocument

Converts an Order domain model to an OrderDocument for persistence.

toDto

fun Order.toDto(): OrderDto

updateItems

fun updateItems(newItems: List<OrderItem>): Order.UpdateResult

Updates the items in the order after validating them.