@ExperimentalApi public interface CachedPlanManager extends FilteringPlanManager
Modifier and Type | Method and Description |
---|---|
boolean |
assertPlanPermission(PlanIdentifier plan)
Used to validate user permission for plan.
|
List<ImmutableChainBranch> |
getBranchesForChain(PlanIdentifier chain)
Get all feature branches associated with the given chain
|
ImmutableJob |
getMasterOfJob(PlanKey masterChainKey,
PlanKey jobKey) |
ImmutableChain |
getMasterPlan(PlanKey branchKey)
Returns master branch for a given branchKey.
|
<T extends ImmutablePlan> |
getPlanById(long id,
Class<T> planType)
Returns a
ImmutablePlan by its database id and Class |
ImmutablePlan |
getPlanByKey(PlanKey planKey)
Returns a
ImmutablePlan by its planKey |
<T extends ImmutablePlan> |
getPlanByKey(PlanKey planKey,
Class<T> planType)
Returns a
ImmutablePlan by its planKey and Class |
<T extends ImmutablePlan> |
getPlanByKeyIfOfType(PlanKey planKey,
Class<T> planType)
|
List<ImmutableTopLevelPlan> |
getPlans()
Returns all
TopLevelPlan 's. |
<T extends ImmutablePlan> |
getPlans(Class<T> planType)
|
<T extends ImmutablePlan> |
getPlans(Class<T> planType,
com.google.common.base.Predicate<? super T> filter)
|
List<ImmutableTopLevelPlan> |
getPlansByProject(Project project)
Returns all
ImmutableTopLevelPlan 's filtered by Project . |
<T extends ImmutablePlan> |
getPlansByProject(Project project,
Class<T> planType)
|
<T extends ImmutablePlan> |
getPlansByProject(Project project,
Class<T> planType,
com.google.common.base.Predicate<? super T> filter) |
List<ImmutableTopLevelPlan> |
getPlansUnrestricted()
Returns all
ImmutableTopLevelPlan 's ignoring permissions. |
Iterable<ImmutableChain> |
getPlansWithRepository(PlanRepositoryIndex.Query query)
Returns chains that use repositories with given params
|
boolean |
isBranchOf(PlanKey chainKey,
PlanKey branchKey)
Test if plan identified by branchKey is a branch of plan identified by chainKey.
|
getAllPlansForClone, getEditablePlansByProject, getPlansForClone, getRunnablePlans, getRunnablePlansByProject
@Nullable ImmutablePlan getPlanByKey(@NotNull PlanKey planKey)
ImmutablePlan
by its planKeyplanKey
- to search for@Nullable <T extends ImmutablePlan> T getPlanByKey(@NotNull PlanKey planKey, Class<T> planType) throws IncorrectPlanTypeException
ImmutablePlan
by its planKey and Class
planKey
- to search forplanType
- - the type of the plan to retrieveIncorrectPlanTypeException
- if plan cannot be found with the correct type@Nullable <T extends ImmutablePlan> T getPlanByKeyIfOfType(@NotNull PlanKey planKey, @NotNull Class<T> planType)
Plan
by its planKey and if it's of the type Class
. Does not throw IncorrectPlanTypeException
. Should only be used when the type of the plan can not be known.T
- planKey
- planType
- @Nullable <T extends ImmutablePlan> T getPlanById(long id, Class<T> planType) throws IncorrectPlanTypeException
ImmutablePlan
by its database id and Class
id
- to search forplanType
- - the type of the plan to retrieveIncorrectPlanTypeException
- if plan cannot be found with the correct type@NotNull List<ImmutableTopLevelPlan> getPlans()
TopLevelPlan
's.
This method is Acegi-filtered.@NotNull List<ImmutableTopLevelPlan> getPlansUnrestricted()
ImmutableTopLevelPlan
's ignoring permissions.@NotNull <T extends ImmutablePlan> List<T> getPlans(Class<T> planType)
Plan
's filtered by Class
. Does not include plans marked for deletion.
This method is Acegi-filtered.planType
- - the type of the plan to retrieveDescriptionProvider.getName()
@NotNull <T extends ImmutablePlan> List<T> getPlans(Class<T> planType, @NotNull com.google.common.base.Predicate<? super T> filter)
Plan
's filtered by Class
. Does not include plans marked for deletion.
This method is Acegi-filtered.planType
- - the type of the plan to retrieveDescriptionProvider.getName()
@NotNull List<ImmutableTopLevelPlan> getPlansByProject(Project project)
ImmutableTopLevelPlan
's filtered by Project
.
This method is Acegi-filtered.project
- - that the plans will belong toImmutableTopLevelPlan
plans contained within the given project@NotNull <T extends ImmutablePlan> List<T> getPlansByProject(Project project, Class<T> planType)
project
- - that the plans will belong toplanType
- - the type of the plan to retrieve<T extends ImmutablePlan> List<T> getPlansByProject(@NotNull Project project, @NotNull Class<T> planType, @NotNull com.google.common.base.Predicate<? super T> filter)
@NotNull List<ImmutableChainBranch> getBranchesForChain(@NotNull PlanIdentifier chain)
chain
- - the masterChainBranch
s associated with the given chain.@Nullable ImmutableChain getMasterPlan(@NotNull PlanKey branchKey)
branchKey
- key of a branchboolean isBranchOf(@NotNull PlanKey chainKey, @NotNull PlanKey branchKey)
chainKey
- key of master branchbranchKey
- key of alleged branchboolean assertPlanPermission(@NotNull PlanIdentifier plan)
plan
- to check the permissions of@Nullable ImmutableJob getMasterOfJob(@NotNull PlanKey masterChainKey, @NotNull PlanKey jobKey)
Iterable<ImmutableChain> getPlansWithRepository(@NotNull PlanRepositoryIndex.Query query)
Copyright © 2016 Atlassian Software Systems Pty Ltd. All rights reserved.