com.atlassian.jira.issue.vote
Interface VoteManager

All Known Implementing Classes:

DefaultVoteManager

public interface VoteManager

The vote manager is responsible for counting issue votes.

Method Summary

boolean	addVote(com.atlassian.crowd.embedded.api.User user, org.ofbiz.core.entity.GenericValue issue) Adds a new vote for the user and issue specified.
boolean	addVote(com.atlassian.crowd.embedded.api.User user, Issue issue) Adds a new vote for the user and issue specified.
List<VoteHistoryEntry>	getVoteHistory(Issue issue) Get the list of vote history for an issue.
List<com.atlassian.crowd.embedded.api.User>	getVoters(Issue issue, Locale usersLocale) Returns an ordered list of voters for a particular issue.
Collection<String>	getVoterUsernames(org.ofbiz.core.entity.GenericValue issue) Return a collection of usernames of users that voted for given issue
Collection<String>	getVoterUsernames(Issue issue) Return a collection of usernames of users that voted for the given issue.
boolean	hasVoted(com.atlassian.crowd.embedded.api.User user, org.ofbiz.core.entity.GenericValue issue) Checks if the collection of #getVoters(java.util.Locale, org.ofbiz.core.entity.GenericValue) contains the user supplied.
boolean	hasVoted(com.atlassian.crowd.embedded.api.User user, Issue issue) Checks if the given User has voted on the given Issue.
boolean	isVotingEnabled() Retrieves the 'jira.option.voting' property
boolean	removeVote(com.atlassian.crowd.embedded.api.User user, org.ofbiz.core.entity.GenericValue issue) Removes a vote for the user and issue specified.
boolean	removeVote(com.atlassian.crowd.embedded.api.User user, Issue issue) Removes a vote for the user and issue specified.
void	removeVotesForUser(com.atlassian.crowd.embedded.api.User user) Removes all votes made by user.

Method Detail

addVote

boolean addVote(com.atlassian.crowd.embedded.api.User user,
                Issue issue)

Adds a new vote for the user and issue specified.

Parameters:

user - the User

issue - the Issue

Returns:

True if the vote succeeded. False if the user or issue supplied were null, or if the resolution is set or if voting is disabled.

addVote

boolean addVote(com.atlassian.crowd.embedded.api.User user,
                org.ofbiz.core.entity.GenericValue issue)

Adds a new vote for the user and issue specified.

Parameters:

user - the User

issue - the Issue

Returns:

false, if the user or issue supplied were null, or if the resolution is set or if voting is disabled. True if the vote succeeded.

removeVote

boolean removeVote(com.atlassian.crowd.embedded.api.User user,
                   Issue issue)

Removes a vote for the user and issue specified.

Parameters:

user - the User

issue - the Issue

Returns:

true if removing a vote succeeded.

removeVote

boolean removeVote(com.atlassian.crowd.embedded.api.User user,
                   org.ofbiz.core.entity.GenericValue issue)

Removes a vote for the user and issue specified.

Parameters:

user - the User

issue - the Issue

Returns:

false, if the user or issue supplied were null, or if the resolution is set or if voting is disabled. True if removing a vote succeeded.

getVoters

List<com.atlassian.crowd.embedded.api.User> getVoters(Issue issue,
                                                      Locale usersLocale)

Returns an ordered list of voters for a particular issue.

Parameters:

issue - the Issue

usersLocale - the locale of the user making this call which is used to sort the results.

Returns:

an ordered list of voters for a particular issue.

Since:

v4.3

getVoterUsernames

Collection<String> getVoterUsernames(Issue issue)

Return a collection of usernames of users that voted for the given issue.

Parameters:

issue - the Issue

Returns:

a collection of usernames, never null

Since:

v4.3

getVoterUsernames

Collection<String> getVoterUsernames(org.ofbiz.core.entity.GenericValue issue)

Return a collection of usernames of users that voted for given issue

Parameters:

issue - issue voted for

Returns:

a collection of usernames, never null

Since:

v3.13

getVoteHistory

List<VoteHistoryEntry> getVoteHistory(Issue issue)

Get the list of vote history for an issue. The history will be in time sequence.

Parameters:

issue - the issue to view

Returns:

List of Vote History Entries

isVotingEnabled

boolean isVotingEnabled()

Retrieves the 'jira.option.voting' property

Returns:

True if voting is enabled

hasVoted

boolean hasVoted(com.atlassian.crowd.embedded.api.User user,
                 Issue issue)

Checks if the given User has voted on the given Issue.

Parameters:

user - the User

issue - the Issue

Returns:

True if the user has voted.

hasVoted

boolean hasVoted(com.atlassian.crowd.embedded.api.User user,
                 org.ofbiz.core.entity.GenericValue issue)

Checks if the collection of #getVoters(java.util.Locale, org.ofbiz.core.entity.GenericValue) contains the user supplied.

Parameters:

user - the User

issue - the Issue

Returns:

True if the user has voted.

removeVotesForUser

void removeVotesForUser(com.atlassian.crowd.embedded.api.User user)

Removes all votes made by user. Usually means user is being deleted.

Parameters:

user - user to remove vote associations for.

Since:

v3.13