net.nemerosa.ontrack.model.settings.PredefinedValidationStampService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ontrack-model Show documentation

Ontrack module: ontrack-model

There is a newer version: 4.4.5

package net.nemerosa.ontrack.model.settings;

import net.nemerosa.ontrack.common.Document;
import net.nemerosa.ontrack.model.Ack;
import net.nemerosa.ontrack.model.structure.ID;
import net.nemerosa.ontrack.model.structure.PredefinedValidationStamp;

import java.util.List;
import java.util.Optional;

/**
 * Management of predefined validation stamps.
 */
public interface PredefinedValidationStampService {

    /**
     * Gets the list of predefined validation stamps.
     */
    List getPredefinedValidationStamps();

    /**
     * Creates a new predefined validation stamp.
     */
    PredefinedValidationStamp newPredefinedValidationStamp(PredefinedValidationStamp stamp);

    /**
     * Gets a predefined validation stamp using its ID
     */
    PredefinedValidationStamp getPredefinedValidationStamp(ID id);

    /**
     * Gets the image for a predefined validation stamp
     */
    Document getPredefinedValidationStampImage(ID id);

    /**
     * Gets a predefined validation stamp using its name
     */
    Optional findPredefinedValidationStampByName(String name);

    /**
     * Updates the predefined validation stamp
     */
    void savePredefinedValidationStamp(PredefinedValidationStamp stamp);

    /**
     * Deletes a predefined validation stamp
     */
    Ack deletePredefinedValidationStamp(ID predefinedValidationStampId);

    /**
     * Sets the image for a predefined validation stamp
     */
    void setPredefinedValidationStampImage(ID predefinedValidationStampId, Document document);
}