com.atlassian.bamboo.author

Interface AuthorDao

All Superinterfaces:

BambooObjectDao<ExtendedAuthor>

All Known Implementing Classes:

AuthorHibernateDao

public interface AuthorDao
extends BambooObjectDao<ExtendedAuthor>

Method Summary

Modifier and Type	Method and Description
@NotNull Collection<? extends ExtendedAuthor>	findAll() Get all ExtendedAuthor entities
@NotNull List<Author>	findAuthorsByLinkedUser(@NotNull String userSearchString) Performs a case insensitive search for authors by their linkedUserName.
@NotNull List<Author>	findAuthorsByName(@NotNull String authorSearchString) Performs a case insensitive search for authors by their author name.
@NotNull List<Author>	findAuthorsThatStartWith(String authorSearchString, boolean unlinkedOnly) Performs a case insensitive search for authors by their author name.
@Nullable ExtendedAuthor	findById(long id) Find an ExtendedAuthor object of a given id.
@NotNull Set<ExtendedAuthor>	getAllUnlinkedAuthors()
@Nullable ExtendedAuthor	getAuthorByName(String name)
@NotNull Set<Author>	getAuthorsByResultSummary(@NotNull ResultsSummary resultsSummary) Retrieve unique set of authors that contributed to commits related to a given ResultsSummary
@NotNull List<ResultsSummary>	getBuildResultsBrokenByAuthor(ExtendedAuthor author, int maxResultCount)
@NotNull List<ResultsSummary>	getBuildResultsFailedByAuthor(ExtendedAuthor author, int maxResultCount)
@NotNull List<ResultsSummary>	getBuildResultsFixedByAuthor(ExtendedAuthor author, int maxResultCount)
@NotNull List<ResultsSummary>	getBuildResultsSuccessfulByAuthor(ExtendedAuthor author, int maxResultCount)
@NotNull List<ResultsSummary>	getBuildResultsTriggeredByAuthor(ExtendedAuthor author, int maxResultCount)
@NotNull List<ExtendedAuthor>	getLinkedAuthorsForUser(com.atlassian.user.User user)
int	getNumberOfBuildBrokenByAuthor(ExtendedAuthor author)
int	getNumberOfBuildFixedByAuthor(ExtendedAuthor author)
int	getNumberOfBuildsTriggeredByAuthor(ExtendedAuthor author)
int	getNumberOfFailedBuildsByAuthor(ExtendedAuthor author)
int	getNumberOfSuccessfulBuildsByAuthor(ExtendedAuthor author)
List<ResultsSummary>	getRecentResultsTriggeredByAuthors(List<ExtendedAuthor> author, int maxDays) Retrieve all build results triggered by the author in the last X days
void	unlinkLinkedAuthors(@NotNull String username) Removes all links between a user and author entities.
default void	unlinkLinkedAuthors(@NotNull com.atlassian.user.User user) Deprecated. since 6.8 use unlinkLinkedAuthors(String)
void	updateLinkedAuthors(@NotNull com.atlassian.user.User user, @NotNull List<Long> authorIds) Updates list of Authors linked to a User.

Methods inherited from interface com.atlassian.bamboo.persistence3.BambooObjectDao

countAll, countWithRestriction, delete, deleteAll, findAll, findById, merge, save, saveAll

Method Detail

findById

@Nullable
@Nullable ExtendedAuthor findById(long id)

Find an ExtendedAuthor object of a given id.

Parameters:

id - id of Author to be found

Returns:

ExtendedAuthor object or null if not found

findAll

@NotNull
@NotNull Collection<? extends ExtendedAuthor> findAll()

Get all ExtendedAuthor entities

Returns:

Collection of ExtendedAuthor

getAuthorByName

@Nullable
@Nullable ExtendedAuthor getAuthorByName(String name)

Parameters:

name -

Returns:

a ExtendedAuthor object given an author name

getBuildResultsTriggeredByAuthor

@NotNull
@NotNull List<ResultsSummary> getBuildResultsTriggeredByAuthor(ExtendedAuthor author,
                                                                        int maxResultCount)

Parameters:

author -

maxResultCount -

Returns:

List of BuildResultsSummary triggered by author

getBuildResultsFailedByAuthor

@NotNull
@NotNull List<ResultsSummary> getBuildResultsFailedByAuthor(ExtendedAuthor author,
                                                                     int maxResultCount)

Parameters:

author -

maxResultCount -

Returns:

List of BuildResultsSummary triggered by author and failed

getBuildResultsSuccessfulByAuthor

@NotNull
@NotNull List<ResultsSummary> getBuildResultsSuccessfulByAuthor(ExtendedAuthor author,
                                                                         int maxResultCount)

Parameters:

author -

maxResultCount -

Returns:

List of BuildResultsSummary triggered by author and succesful

getBuildResultsBrokenByAuthor

@NotNull
@NotNull List<ResultsSummary> getBuildResultsBrokenByAuthor(ExtendedAuthor author,
                                                                     int maxResultCount)

Parameters:

author -

maxResultCount -

Returns:

List of BuildResultsSummary broken by author

getBuildResultsFixedByAuthor

@NotNull
@NotNull List<ResultsSummary> getBuildResultsFixedByAuthor(ExtendedAuthor author,
                                                                    int maxResultCount)

Parameters:

author -

maxResultCount -

Returns:

List of BuildResultsSummary fixed by author

getNumberOfBuildsTriggeredByAuthor

int getNumberOfBuildsTriggeredByAuthor(ExtendedAuthor author)

Parameters:

author -

Returns:

int

getNumberOfFailedBuildsByAuthor

int getNumberOfFailedBuildsByAuthor(ExtendedAuthor author)

Parameters:

author -

Returns:

int

getNumberOfSuccessfulBuildsByAuthor

int getNumberOfSuccessfulBuildsByAuthor(ExtendedAuthor author)

Parameters:

author -

Returns:

int

getNumberOfBuildFixedByAuthor

int getNumberOfBuildFixedByAuthor(ExtendedAuthor author)

Parameters:

author -

Returns:

int

getNumberOfBuildBrokenByAuthor

int getNumberOfBuildBrokenByAuthor(ExtendedAuthor author)

Parameters:

author -

Returns:

int

getAllUnlinkedAuthors

@NotNull
@NotNull Set<ExtendedAuthor> getAllUnlinkedAuthors()

Returns:

Set of ExtendedAuthor which are not yet linked to any user.

getLinkedAuthorsForUser

@NotNull
@NotNull List<ExtendedAuthor> getLinkedAuthorsForUser(com.atlassian.user.User user)

Parameters:

user -

Returns:

List of ExtendedAuthor which are linked to a given user.

getRecentResultsTriggeredByAuthors

List<ResultsSummary> getRecentResultsTriggeredByAuthors(List<ExtendedAuthor> author,
                                                        int maxDays)

Retrieve all build results triggered by the author in the last X days

Parameters:

author - the builds will be triggered by

maxDays - number of days to look back in history

Returns:

all build results triggered by the author in the last X days

unlinkLinkedAuthors

@Deprecated
default void unlinkLinkedAuthors(@NotNull
                                             @NotNull com.atlassian.user.User user)

Deprecated. since 6.8 use unlinkLinkedAuthors(String)

Removes the link between User and all Author entities, User was linked to

Parameters:

user - user

unlinkLinkedAuthors

void unlinkLinkedAuthors(@NotNull
                         @NotNull String username)

Removes all links between a user and author entities.

Parameters:

username - name of the user

updateLinkedAuthors

void updateLinkedAuthors(@NotNull
                         @NotNull com.atlassian.user.User user,
                         @NotNull
                         @NotNull List<Long> authorIds)

Updates list of Authors linked to a User. As a result of this operation only Authors with id listed in authorIds will be linked to user

Parameters:

user - user

authorIds - list of Author id that should be linked to user

findAuthorsByName

@NotNull
@NotNull List<Author> findAuthorsByName(@NotNull
                                                 @NotNull String authorSearchString)

Performs a case insensitive search for authors by their author name. AuthorSearchString can appear anywhere in the authors name.

Parameters:

authorSearchString - string to search for

Returns:

any authors who's author name match the given string.

findAuthorsThatStartWith

@NotNull
@NotNull List<Author> findAuthorsThatStartWith(String authorSearchString,
                                                        boolean unlinkedOnly)

Performs a case insensitive search for authors by their author name.

Parameters:

authorSearchString - string to search for

unlinkedOnly - if true will only return users which have not been linked with a user already

Returns:

any authors who's author name match the given string.

findAuthorsByLinkedUser

@NotNull
@NotNull List<Author> findAuthorsByLinkedUser(@NotNull
                                                       @NotNull String userSearchString)

Performs a case insensitive search for authors by their linkedUserName. userSearchString can appear anywhere in the linked user name.

Parameters:

userSearchString - string to search for

Returns:

any authors who's linkedusername match the given string.

getAuthorsByResultSummary

@NotNull
@NotNull Set<Author> getAuthorsByResultSummary(@NotNull
                                                        @NotNull ResultsSummary resultsSummary)

Retrieve unique set of authors that contributed to commits related to a given ResultsSummary

Parameters:

resultsSummary - ResultsSummary

Returns:

list of authors