All Classes and Interfaces
Class
Description
Default
DemoDataGenerator implementation for models that provide only a single demo data set with ID
"BASIC"<ModelInput_ extends ModelInput, ModelConfigOverrides_ extends ModelConfigOverrides>.Event referencing the associated
Metadata.Base class for all validation issues.
For full backward compatibility with legacy validation issues of existing models.
Represents a simplified model with the default score type
HardMediumSoftScore acting as the ModelInput,
SolverModel and ModelOutput.This event is sent when a new best solution is found during the solving process.
Describes a single constraints and its parameters.
Describes a group constraints.
Groups related constraints into a single category for model description.
Describes a score constraint in a form suitable for model descriptors and other consumer-facing metadata.
Annotates a field in a
ModelConfigDescriptor to reference a constraint.Event sent when the outputs of a dataset are computed before solving.
Event that a new dataset is submitted via the API.
Sent when a dataset is successfully validated by
ModelValidator.Demo data generator for models that can be used to verify execution of the model's logic.
Describes the documentation support for a model.
Specifies the level of documentation support available for a model.
Sent when a solver worker fails during solving.
Sent when the solver worker produces the final best solution upon termination conditions.
Sent when a solver worker produces the first, initialized, solution.
Defines InputMetric of the model where information is retrieved from
ModelInputMetric class of the model
id - usually the field of the class representing given InputMetric
name - human readable name
description - human readable description of the InputMetric
type - type of the InputMetric that provides information how to handle given InputMetric and what operations can be
performed on it e.g.
number, duration, distance_meters
priority - order in which InputMetric should be presented
example - value that this InputMetric can hold
exampleFormatted - example but formatted according to given type .e.g distance in meters can be presented in kilometers
for better readability
Represents a single validation issue discovered during model validation.
Event that indicates a dataset has failed during processing.
Event sent when the solver worker starts solving the dataset.
Internal validation issue to translate a JSON parsing error
to the
ValidationResult.Holds build-time metadata about the Timefold Solver model, including version information and source control details
captured at build time.
Describes a model configuration.
Represents a constraint parameter, which is the constraint weight or any other parameter impacting the constraint behavior.
The convertor of:
The
ModelInput and the ModelConfig (usually obtained from the
ModelRequest) into the SolverModel usable by the Timefold Solver.
The SolverModel representing a planning solution into the ModelOutput (usually forming a part
of the ModelResponse).
Root interface for all
ModelConvertor implementations.Provides a complex validation of the model input before the solving, or other operation, starts.
Command that is expected to be executed by solver worker upon start.
Defines Output Metric of the model where information is retrieved from
ModelOutputMetrics class of the model
id - usually the field of the class representing given Output Metric
name - human readable name
description - human readable description of the Output Metrics
type - type of the Output Metric that provides information how to handle given Output Metric and what operations can be
performed on it e.g.
number, duration, distance_meters
priority - order in which Output Metrics should be presented
example - value that this Output Metrics can hold
exampleFormatted - example but formatted according to given type .e.g distance in meters can be presented in kilometers
for better readability
Resource configuration.
Root interface for all
SolverModelEnricher implementations.Provides a model-specific way of enriching a solver model, typically for models using multiple enrichers depending on each
other.
Root interface for all
SolverModelEnrichmentDirector implementations.Base class for events produced by the SolverWorker.
Facade used by the REST layer to interact with dataset storage and the solver worker,
without depending on storage or messaging internals directly.
Represents the dateset lifecycle.
Storage responsible for persisting
ModelOutput_ and its sub resources into a data storeProvides storage address used to store user model and its sub resources in the underlying data store
Configuration of trial use of the model
trialDuration - duration in days of the trial period model can be used
maxExtensions - max number of extensions trial can have
extensionDuration - duration in days indicating how long trial can be extended for
Represents the type of UI support available.
Registers individual validation issues to later build the
ValidationResult instance.Provides all supported
validation issue types.A compact summary of a dataset validation, carrying the overall
ValidationStatus and issue counts by
IssueCode split by severity.Describes a visualization page that a UI should render for a model.