IBranchDocumentConfiguration

public interface IBranchDocumentConfiguration

A branch configuration for a Document.

Since:: 3.23.10

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static interface

IBranchDocumentConfiguration.IBuilder
Method Summary

Modifier and Type

Method

Description

boolean

copyWorkflowStatusAndSignatures()

Specifies that workflow status and signatures should be copied to the branched document.

Collection<String>

initializedFields()

boolean

overwriteWorkItems()

String

query()

Only Work Items matching the given query will be included in the branched Document.

IModule

sourceDocument()

String

targetName()

IProject

targetProject()

ILocation

targetSpace()

String

targetTitle()

boolean

updateTitleHeading()

Specifies that title heading should be updated to match the targetTitle().

Method Details
- sourceDocument
  
  @NotNull IModule sourceDocument()
- targetProject
  
  @NotNull IProject targetProject()
- targetSpace
  
  @NotNull ILocation targetSpace()
- targetName
  
  @NotNull String targetName()
- targetTitle
  
  @NotNull String targetTitle()
- updateTitleHeading
  
  boolean updateTitleHeading()
  
  Specifies that title heading should be updated to match the targetTitle(). By default the title heading is updated.
- query
  
  @Nullable String query()
  
  Only Work Items matching the given query will be included in the branched Document. By default all Work Items are selected.
- copyWorkflowStatusAndSignatures
  
  boolean copyWorkflowStatusAndSignatures()
  
  Specifies that workflow status and signatures should be copied to the branched document.
- overwriteWorkItems
  
  boolean overwriteWorkItems()
  
  Returns:
  
  true if all Work Items in a branched document should be overwritten. Relative links are kept by default
- initializedFields
  
  @NotNull Collection<String> initializedFields()
  
  Returns:
  
  list of fields to be cleared and initialized with default values.