com.atlassian.jira.issue.vote
Interface IssueVoterAccessor

All Known Implementing Classes:

DefaultIssueVoterAccessor

public interface IssueVoterAccessor

Get all voters for an issue.

Since:

v4.1

Method Summary

Iterable<User>	getDetails(Locale displayLocale, Issue issue) Deprecated. Use getVoters(java.util.Locale, com.atlassian.jira.issue.Issue). Since 4.3
<T> Iterable<T>	getDetails(Locale displayLocale, Issue issue, Function<User,T> transformer) Deprecated. Use getVoters(java.util.Locale, com.atlassian.jira.issue.Issue). Since 4.3
Iterable<String>	getVoterNames(Issue issue) Convenience function that simply returns the User names.
Iterable<com.atlassian.crowd.embedded.api.User>	getVoters(Locale displayLocale, Issue issue) Convenience function that simply returns the User objects.
boolean	isVotingEnabled()

Method Detail

isVotingEnabled

boolean isVotingEnabled()

getVoterNames

@NotNull
Iterable<String> getVoterNames(@NotNull
                                       Issue issue)

Convenience function that simply returns the User names.

Parameters:

issue - the issue to get the voters for

Returns:

an Iterable of the user names, empty if no voters

getDetails

@NotNull
Iterable<User> getDetails(@NotNull
                                  Locale displayLocale,
                                  @NotNull
                                  Issue issue)

Deprecated. Use getVoters(java.util.Locale, com.atlassian.jira.issue.Issue). Since 4.3

Convenience function that simply returns the User objects.

Parameters:

displayLocale - for sorting.

issue - the issue to get the voters for

Returns:

an Iterable of the users, empty if no voters

getVoters

@NotNull
Iterable<com.atlassian.crowd.embedded.api.User> getVoters(@NotNull
                                                                  Locale displayLocale,
                                                                  @NotNull
                                                                  Issue issue)

Convenience function that simply returns the User objects.

Parameters:

displayLocale - for sorting.

issue - the issue to get the voters for

Returns:

an Iterable of the users, empty if no voters

getDetails

@NotNull
<T> Iterable<T> getDetails(@NotNull
                                   Locale displayLocale,
                                   @NotNull
                                   Issue issue,
                                   @NotNull
                                   Function<User,T> transformer)

Deprecated. Use getVoters(java.util.Locale, com.atlassian.jira.issue.Issue). Since 4.3

Return an Iterable of all voters for the supplied issue. The elements are of the type the transformer function returns.

Type Parameters:

T - the type of element in the returned iterable.

Parameters:

displayLocale - for sorting.

issue - the issue to get the voters for

transformer - to get the required details from the User objects.

Returns:

an Iterable of the user details, empty if no voters