Package com.atlassian.bamboo.plan

Interface PlanIdentifier

All Superinterfaces:
BambooIdProvider, DescriptionProvider, NameProvider, PlanKeyProvider
All Known Subinterfaces:
Buildable, Chain, ChainBranch, ChainBranchIdentifier, ImmutableBuildable, ImmutableChain, ImmutableChainBranch, ImmutableJob, ImmutablePlan, ImmutableTopLevelPlan, Job, Plan, TopLevelPlan
All Known Implementing Classes:
AbstractChain, AbstractImmutableChain, AbstractImmutablePlan, AbstractPlan, ChainBranchIdentifierImpl, ChainBranchImpl, DecoratedPlan, DecoratedPlan.DecoratedBranch, DefaultChain, DefaultJob, ImmutableChainBranchImpl, ImmutableChainImpl, ImmutableJobImpl, PlanIdentifierImpl
public interface PlanIdentifier extends BambooIdProvider, DescriptionProvider, PlanKeyProvider
Represents the minimal information about a Plan
Since:
v4.0

  • Field Details

  • Method Details

    • getId

      long getId()
      Returns database id of the plan. Use of getDatabaseId() should be preferred.
      Specified by:
      getId in interface BambooIdProvider
      Throws:
      IllegalStateException - if this plan is not a DB object.

    • getDatabaseId

      @NotNull @NotNull Optional<Long> getDatabaseId()
      Returns:
      database id of the plan or empty if this plan is not a DB object.

    • getMasterId

      @Deprecated long getMasterId()
      Deprecated.
      since 6.9 use getMasterIdIfExists() instead
      Returns:
      database id of master of this Plan or -1 if none.

    • getMasterIdIfExists

      @NotNull @NotNull Optional<Long> getMasterIdIfExists()
      Returns:
      database id of master of this Plan or empty if none.

    • getPlanType

      @NotNull @NotNull PlanType getPlanType()
      Returns:
      the type of this plan

    • getPlanKey

      @NotNull @NotNull PlanKey getPlanKey()
      Get the PlanKey identifier for this Plan
      Specified by:
      getPlanKey in interface PlanKeyProvider
      Returns:
      planKey

    • getBuildKey

      @NotNull @NotNull String getBuildKey()
      This objects specific portion of the key. You probably want to use getPlanKey().
      Returns:
      This objects specific portion of the key

    • getName

      @NotNull @NotNull String getName()
      Returns the full name for the build in the form of "project name - build name" e.g. "Confluence - HEAD"
      Specified by:
      getName in interface DescriptionProvider
      Specified by:
      getName in interface NameProvider
      Returns:
      String

    • getBuildName

      @NotNull @NotNull String getBuildName()
      Returns:
      The plan specific portion of the name (without the project and/or parent's names). You probably want to use getName()

    • isSuspendedFromBuilding

      boolean isSuspendedFromBuilding()
      Checks if the build has been enabled / disabled.
      Returns:
      true if plan is disabled

    • getProject

      @NotNull @NotNull ProjectIdentifier getProject()
      Returns the parent Project
      Returns:
      Project. Never null