Package com.polarion.alm.tracker

Interface IModuleBrancher

public interface IModuleBrancher
Since:
3.6.0

  • Method Summary

    Modifier and Type
    Method
    Description
    com.polarion.alm.tracker.internal.ModuleBrancher
    copyWorkflowStatusAndSignatures(boolean value)
    Specifies that workflow status and signatures should be copied to the branched document.
    IModule
    execute()
    Executes the branching of the module and returns the resulting module which is already saved (method IModule.save() was called, so the caller does not have to do anything with the returned module.
    com.polarion.alm.tracker.internal.ModuleBrancher
    filterBy(String query)
    Specifies optional filtering query.
    com.polarion.alm.tracker.internal.ModuleBrancher
    freezeReferences(boolean value)
    Specifies that referenced Work Item revisions should be frozen.

  • Method Details

    • filterBy

      @NotNull com.polarion.alm.tracker.internal.ModuleBrancher filterBy(String query)
      Specifies optional filtering query.
      Throws:
      IllegalStateException - if called after execute()

    • copyWorkflowStatusAndSignatures

      @NotNull com.polarion.alm.tracker.internal.ModuleBrancher copyWorkflowStatusAndSignatures(boolean value)
      Specifies that workflow status and signatures should be copied to the branched document.
      Parameters:
      value - true to copy the workflow status and signatures
      Throws:
      IllegalStateException - if called after execute()
      Since:
      3.9.0

    • freezeReferences

      @NotNull com.polarion.alm.tracker.internal.ModuleBrancher freezeReferences(boolean value)
      Specifies that referenced Work Item revisions should be frozen. If this method is NOT used, then if you branch from a Document's HEAD revision, referenced Work Items also lead to their HEAD revisions. If you branch from a historical Document revision, then referenced Work Items are frozen to the same historical Document revision.
      Parameters:
      value - true to freeze reference revisions
      Throws:
      IllegalStateException - if called after execute()
      Since:
      3.21.2

    • execute

      @NotNull IModule execute()
      Executes the branching of the module and returns the resulting module which is already saved (method IModule.save() was called, so the caller does not have to do anything with the returned module.