com.atlassian.bamboo.plan
Interface PlanManager

All Known Implementing Classes:

DefaultPlanManager, MockBuildManager

public interface PlanManager

Manager for all Plan types within Bamboo Use this manager if you need to address Builds, Plans, etc.

Method Summary

java.util.Collection<Plan>	getAllPlans() Returns all Plan's
Plan	getPlanById(long id) Returns a Plan by its id
Plan	getPlanByKey(java.lang.String planKey) Returns a Plan by its planKey
void	savePlan(Plan plan) Saves the Plan
void	updateLatestVcsKey(Plan plan, java.lang.String vcsRevisionKey) Updates the build to the latest passed revision key

Method Detail

getPlanById

@Nullable
Plan getPlanById(long id)

Returns a Plan by its id

Parameters:

id -

Returns:

getPlanByKey

@Nullable
Plan getPlanByKey(@NotNull
                           java.lang.String planKey)

Returns a Plan by its planKey

Parameters:

planKey -

Returns:

plan

getAllPlans

@NotNull
java.util.Collection<Plan> getAllPlans()

Returns all Plan's

Returns:

plans

savePlan

void savePlan(@NotNull
              Plan plan)

Saves the Plan

Parameters:

plan -

updateLatestVcsKey

void updateLatestVcsKey(@NotNull
                        Plan plan,
                        @NotNull
                        java.lang.String vcsRevisionKey)

Updates the build to the latest passed revision key

Parameters:

plan - - Plan key

vcsRevisionKey - - revision key