Package com.atlassian.bamboo.labels

Interface LabelManager

  • All Known Implementing Classes:
    LabelManagerImpl
    public interface LabelManager

    • Method Detail

      • addLabel

        int addLabel​(@Nullable
             @Nullable String labelName,
             @Nullable
             @Nullable PlanResultKey planResultKey,
             @Nullable
             @Nullable com.atlassian.user.User user)
        Add a label against a build result.
        Parameters:
        labelName -
        planResultKey -
        user -
        Returns:
        an int identifying result of add process

      • removeLabel

        int removeLabel​(String labelName,
                PlanResultKey planResultKey,
                com.atlassian.user.User user)
        Removes a label against a build result. Will delete the Label entity if there are no more build results tied to it.
        Parameters:
        labelName -
        planResultKey -
        user -
        Returns:
        an int identifying result of delete process

      • findLabels

        @NotNull
@NotNull List<LabelCount> findLabels​(@NotNull
                                     @NotNull String namespace,
                                     int maxResults,
                                     @Nullable
                                     @Nullable Plan plan,
                                     @Nullable
                                     @Nullable Project project)
        Finds all labels in a given build, with namespace and maxResults.
        Parameters:
        namespace -
        maxResults -
        plan -
        project -
        Returns:
        List of LabelCount objects, mapping (Label to count of occurrences.

      • addFavourite

        int addFavourite​(Plan plan,
                 com.atlassian.user.User user)
        Adds a build to a user as favourite. Adds a label to the build, with namespace = user name, and label name = ":favourite".
        Parameters:
        plan -
        user -
        Returns:
        an int identifying result of add process

      • removeFavourite

        int removeFavourite​(@NotNull
                    @NotNull Plan plan,
                    @Nullable
                    @Nullable com.atlassian.user.User user)
        Removes a build from a user's favourite. Removes labelling object, where namespace = user name, and label name=":favourite".
        Parameters:
        plan -
        user -
        Returns:
        an int identifying result of removal process

      • isManuallyUnmarkedFavourite

        boolean isManuallyUnmarkedFavourite​(@NotNull
                                    @NotNull Plan plan,
                                    @Nullable
                                    @Nullable com.atlassian.user.User user)
        Flag which determines if the user has manually unmarked this build as favourite.
        Parameters:
        plan -
        user -
        Returns:
        boolean flag

      • getFavouritesForPlan

        List<String> getFavouritesForPlan​(ImmutablePlan plan)
        Retrieves a list of usernames which have the given plan set as a favourite.
        Parameters:
        plan -
        Returns:
        list of usernames (as Strings)

      • hasBuildResultsLabel

        boolean hasBuildResultsLabel​(ResultsSummary buildResultsSummary,
                             String label)
        Checks whether the build results summary has a particular label
        Parameters:
        buildResultsSummary -
        label - . could be empty
        Returns:
        Returns true if there is a label object within the correct namespace and a labelling for the ResultsSummary

      • hasPlanLabel

        boolean hasPlanLabel​(Plan plan,
                     String label)
        Checks whether the Plan has a particular label
        Parameters:
        plan -
        label - . could be empty
        Returns:
        Returns true if there is a label object within the correct namespace and a labelling for the Plan

      • getLabelsByName

        Collection<Label> getLabelsByName​(List<String> labelNames)
        Gets list of labels based on label names
        Parameters:
        labelNames -
        Returns:
        list of labels for all existing labels specified in parameter

      • saveLabelling

        void saveLabelling​(Labelling labelling)
        Saves a specific labelling - does not do any validation or checking. If not sure - please use addLabel or addFavourite instead
        Parameters:
        labelling - to save

      • addLabel

        int addLabel​(@Nullable
             @Nullable String labelName,
             @Nullable
             @Nullable PlanKey planKey,
             @Nullable
             @Nullable com.atlassian.user.User user)
        Creates a normal label for a plan
        Parameters:
        labelName -
        planKey -
        user -
        Returns:

      • addLabels

        boolean addLabels​(List<String> labelNames,
                  @Nullable
                  @Nullable PlanKey planKey,
                  @Nullable
                  @Nullable com.atlassian.user.User user)
        Creates multiple normal labels for a plan
        Parameters:
        labelNames -
        planKey -
        user -
        Returns:

      • removeLabel

        int removeLabel​(@Nullable
                @Nullable String labelName,
                @Nullable
                @Nullable PlanKey planKey,
                @Nullable
                @Nullable com.atlassian.user.User user)
        Remove the standard label for a plan (not all the labels for that plan)
        Parameters:
        labelName -
        planKey -
        user -
        Returns:

      • getAllPlanLabels

        @NotNull
@NotNull Set<Label> getAllPlanLabels()
        All labels used on a plan level
        Returns:
        Set of Label related to any plan

      • getPlanLabels

        Set<Label> getPlanLabels​(@NotNull
                         @NotNull ImmutablePlan plan)
        Get labels defined for a plan
        Parameters:
        plan - Plan to filter labels with
        Returns:
        Set of Label related to the plan