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<String>	getVoterNames(Issue issue) Deprecated. Use getVoterUserkeys(com.atlassian.jira.issue.Issue) instead. Since v6.0.
Iterable<com.atlassian.crowd.embedded.api.User>	getVoters(Locale displayLocale, Issue issue) Convenience function that simply returns the User objects.
Iterable<String>	getVoterUserkeys(Issue issue) Returns the userkeys for voters on the given issue.
boolean	isVotingEnabled()

Method Detail

isVotingEnabled

boolean isVotingEnabled()

getVoterNames

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

Deprecated. Use getVoterUserkeys(com.atlassian.jira.issue.Issue) instead. Since v6.0.

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

getVoterUserkeys

@Nonnull
Iterable<String> getVoterUserkeys(@Nonnull
                                          Issue issue)

Returns the userkeys for voters on the given issue.

Parameters:

issue - the issue to get the voters for

Returns:

an Iterable of the user keys, empty if no voters

getVoters

@Nonnull
Iterable<com.atlassian.crowd.embedded.api.User> getVoters(@Nonnull
                                                                  Locale displayLocale,
                                                                  @Nonnull
                                                                  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