org.opentcs.kernel.persistence.ModelPersister Maven / Gradle / Ivy
// SPDX-FileCopyrightText: The openTCS Authors
// SPDX-License-Identifier: MIT
package org.opentcs.kernel.persistence;
import org.opentcs.access.to.model.PlantModelCreationTO;
/**
* Provides methods to persist and load models.
* Only a single model is persisted at a time.
*/
public interface ModelPersister {
/**
* Find out if there is a persisted model at the moment.
*
* @return True if a model is saved.
*/
boolean hasSavedModel();
/**
* Persists a model according to the actual implementation of this method.
*
* @param model The model to be persisted.
* @throws IllegalStateException If persisting the model is not possible for some reason.
*/
void saveModel(PlantModelCreationTO model)
throws IllegalStateException;
/**
* Reads the model and returns it as a PlantModelCreationTO.
*
* @return The PlantModelCreationTO that contains the data that was read.
* @throws IllegalStateException If reading the model is not possible for some reason.
*/
PlantModelCreationTO readModel()
throws IllegalStateException;
}