net.nemerosa.ontrack.model.structure.BranchTemplateService 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.structure;

import net.nemerosa.ontrack.model.Ack;

import java.util.Collection;
import java.util.Optional;

public interface BranchTemplateService {

    /**
     * Gets the template definition for a branch
     */
    Optional getTemplateDefinition(ID branchId);

    /**
     * Gets all template definitions
     * @param project
     */
    Collection getTemplateDefinitions(Project project);

    /**
     * Sets the branch as a template definition or updates the existing definition.
     */
    Branch setTemplateDefinition(ID branchId, TemplateDefinition templateDefinition);

    /**
     * Creates a branch template instance for one name.
     * 
     * 

     * If the target branch does not exist, creates it.
     * If the target branch exists:
     * 
     * If it is linked to the same definition, updates it.
     * If it is linked to another definition, this is an error.
     * If it is a normal branch, this is an error.
     * 
     * 
     * 
     *
     * @param branchId ID of the branch template definition
     * @param request  Request for the creation
     * @return Created or updated branch
     */
    Branch createTemplateInstance(ID branchId, BranchTemplateInstanceSingleRequest request);

    /**
     * Gets a template instance for a branch
     */
    Optional getTemplateInstance(ID branchId);

    /**
     * Sync. this template definition by creating and updating linked template instances.
     */
    BranchTemplateSyncResults sync(ID branchId);

    /**
     * Sync. this template instance against its template definition
     */
    Ack syncInstance(ID branchId);

    /**
     * Disconnects the branch from any template definition, if any.
     */
    Branch disconnectTemplateInstance(ID branchId);

    /**
     * Connects an existing branch to a template
     *
     * @param branchId Branch to connect
     * @param request  Connection request
     * @return Connected branch
     */
    Branch connectTemplateInstance(ID branchId, BranchTemplateInstanceConnectRequest request);
}