SlotFlow API Documentation

Application

Table of Contents

Interfaces

AllocationPolicyInterface
Chooses explicit edge allocations for one flow step.
EdgeFilterPolicyInterface
Removes edges from a step before ordering and allocation.
EdgeOrderingPolicyInterface
Reorders candidate edges for one cascade step.
QttyConstraintPolicyInterface
Caps how much quantity may move through one candidate edge.
SlotCodec
Defines how slots are serialized, deserialized, and pattern-matched.
SolverInterface
Executes one flow against one quantity state.
SlotFlowExceptionInterface
Marker interface for all exceptions thrown by the SlotFlow library.

Classes

BatchInventoryMutation
Backward-compatible alias for BatchQuantityStateDelta.
BatchLedgerEntry
Ledger entry paired with the batch subject it belongs to.
BatchMovementEngine
Executes one flow across all items in a quantity-state batch.
BatchQuantityStateDelta
Quantity-state delta paired with the batch subject it belongs to.
InventoryBatch
Backward-compatible alias for QuantityStateBatch.
QuantityStateBatch
Group of per-subject quantity states to be processed by the batch engine.
Cascade
Backward-compatible inventory-oriented alias for Flow.
DefaultSlotKeyCodec
Built-in dot-separated codec with wildcard and alternative support.
SlotFlowInvalidArgumentException
Raised when a SlotFlow API is called with invalid or inconsistent arguments.
SlotFlowLogicException
Raised when SlotFlow detects an invalid internal or object state transition.
Flow
Named ordered set of movement steps that can be executed by a solver.
Inventory
Backward-compatible commerce-oriented alias for QuantityState.
MovementEdge
One directed movement edge between two slots.
MovementEngine
Executes flows against quantity state via a pluggable solver.
MovementResult
Immutable summary of one cascade execution.
AvailableInventorySortPolicy
Backward-compatible alias for AvailableQuantitySortPolicy.
AvailableQuantitySortPolicy
Sorts edges in descending order of available quantity at the source slot.
DimensionPriority
Orders edges by configured priority tiers on source-slot dimensions.
DistancePolicy
Filters or orders edges by a caller-provided distance metric.
QuantityState
Quantity distribution state for one subject across the slot space.
InventoryMutation
Backward-compatible alias for QuantityStateDelta.
LedgerEntry
Ledger-friendly representation of one movement event.
MovementEvent
One applied movement with before-state snapshots for source and destination.
QuantityStateDelta
Net quantity change for one slot.
EdgeRule
Declarative allow/deny rule for edges between slot patterns.
RuleSet
Composable container for slot and edge rules.
SlotRule
Declarative include/exclude rule for shaping the valid slot space.
AllocationDecision
One explicit quantity allocation to a specific edge.
CascadeContext
Backward-compatible alias for FlowContext.
FlowContext
Runtime context object passed to policies during one flow step.
Slot
One concrete slot in a slot space, or the special `nil` boundary slot.
SlotSpace
Defines the slot space, its dimensions, the slots that exist within it, and the edges and flows that operate on it.
GreedyFlowSolver
Executes flows with deterministic greedy semantics.

        
On this page

Search results