net.nemerosa.ontrack.model.structure

Interface BranchTemplateService

public interface BranchTemplateService

Method Summary

Modifier and Type	Method and Description
Branch	connectTemplateInstance(ID branchId, BranchTemplateInstanceConnectRequest request) Connects an existing branch to a template
Branch	createTemplateInstance(ID branchId, BranchTemplateInstanceSingleRequest request) Creates a branch template instance for one name.
Branch	disconnectTemplateInstance(ID branchId) Disconnects the branch from any template definition, if any.
java.util.Optional<TemplateDefinition>	getTemplateDefinition(ID branchId) Gets the template definition for a branch
java.util.Collection<LoadedBranchTemplateDefinition>	getTemplateDefinitions(Project project) Gets all template definitions
java.util.Optional<TemplateInstance>	getTemplateInstance(ID branchId) Gets a template instance for a branch
Branch	setTemplateDefinition(ID branchId, TemplateDefinition templateDefinition) Sets the branch as a template definition or updates the existing definition.
BranchTemplateSyncResults	sync(ID branchId) Sync.
Ack	syncInstance(ID branchId) Sync.

Method Detail

getTemplateDefinition

java.util.Optional<TemplateDefinition> getTemplateDefinition(ID branchId)

Gets the template definition for a branch

getTemplateDefinitions

java.util.Collection<LoadedBranchTemplateDefinition> getTemplateDefinitions(Project project)

Gets all template definitions

Parameters:

project -

setTemplateDefinition

Branch setTemplateDefinition(ID branchId,
                             TemplateDefinition templateDefinition)

Sets the branch as a template definition or updates the existing definition.

createTemplateInstance

Branch createTemplateInstance(ID branchId,
                              BranchTemplateInstanceSingleRequest request)

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.

Parameters:

branchId - ID of the branch template definition

request - Request for the creation

Returns:

Created or updated branch

getTemplateInstance

java.util.Optional<TemplateInstance> getTemplateInstance(ID branchId)

Gets a template instance for a branch

sync

BranchTemplateSyncResults sync(ID branchId)

Sync. this template definition by creating and updating linked template instances.

syncInstance

Ack syncInstance(ID branchId)

Sync. this template instance against its template definition

disconnectTemplateInstance

Branch disconnectTemplateInstance(ID branchId)

Disconnects the branch from any template definition, if any.

connectTemplateInstance

Branch connectTemplateInstance(ID branchId,
                               BranchTemplateInstanceConnectRequest request)

Connects an existing branch to a template

Parameters:

branchId - Branch to connect

request - Connection request

Returns:

Connected branch