org.chorem.pollen.votecounting.strategy

Interface VoteCountingStrategy

All Known Implementing Classes:

AbstractVoteCountingStrategy

public interface VoteCountingStrategy

Contract of a vote counting method.

Since:

1.4.5

Author:

tchemit

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayVoteValue(Integer voteValue) Get the value to display for a given vote value in the vote page.
String	getI18nHelp() Obtains the i18n help of this strategy.
String	getI18nName() Obtains the i18n name of this strategy.
int	getId() Obtains the unique id of this strategy.
String	getStrategyHelp(Locale locale) Get the vote counting strategy help to display in UI.
String	getStrategyName(Locale locale) Get the vote counting strategy name to display in UI.
String	getTotalVoteValueNotValidMessage(Locale locale) If the total values of a vote is not valid, gets the localized error message.
ChoiceToVoteRenderType	getVoteValueEditorType() Gets the type of editor used to render a vote value.
String	getVoteValueNotValidMessage(Locale locale) If a vote value is not valid, gets the localized message of the error.
boolean	isChoiceInVote(Integer voteValue) Test if the given value is a vote value (says users has filled it).
boolean	isDisplayResultsByChoice() Deprecated. since 1.5 (result will be offered by the strategy it-self).
boolean	isTotalVoteValueValid(int totalValues) Tests if the total values of a vote is valid.
boolean	isVoteValueNull(Integer value) Tests if a given vote value is null or not.
boolean	isVoteValueValid(Integer voteValue) Tests if the given vote value is valid.
VoteCountingResult	votecount(Set<Voter> voter) Vote count for the given voter and return the result of it.

Method Detail

getId

int getId()

Obtains the unique id of this strategy.

Returns:

the unique id of this strategy.

getI18nName

String getI18nName()

Obtains the i18n name of this strategy.

Returns:

the i18n name of this strategy.

getI18nHelp

String getI18nHelp()

Obtains the i18n help of this strategy.

Returns:

the i18n help of this strategy.

votecount

VoteCountingResult votecount(Set<Voter> voter)

Vote count for the given voter and return the result of it.

Parameters:

voter - the voter and their votes.

Returns:

the result of the vote counting for the given voter.

getDisplayVoteValue

String getDisplayVoteValue(Integer voteValue)

Get the value to display for a given vote value in the vote page.

Parameters:

voteValue - the vote value to display

Returns:

the string representation of a vote value

isChoiceInVote

boolean isChoiceInVote(Integer voteValue)

Test if the given value is a vote value (says users has filled it).

Parameters:

voteValue - the vote value to test

Returns:

true if the given value is persisted.

getStrategyName

String getStrategyName(Locale locale)

Get the vote counting strategy name to display in UI.

Parameters:

locale - the locale used to render the strategy name

Returns:

the localized vote counting strategy name

getStrategyHelp

String getStrategyHelp(Locale locale)

Get the vote counting strategy help to display in UI.

Parameters:

locale - the locale used to render the strategy name

Returns:

the localized vote counting strategy help

isVoteValueValid

boolean isVoteValueValid(Integer voteValue)

Tests if the given vote value is valid.

Parameters:

voteValue - the vote value to test

Returns:

true if the given vote value is valid, false otherwise.

getVoteValueNotValidMessage

String getVoteValueNotValidMessage(Locale locale)

If a vote value is not valid, gets the localized message of the error.

Parameters:

locale - the locale used to render the error message

Returns:

the localized validation message

isTotalVoteValueValid

boolean isTotalVoteValueValid(int totalValues)

Tests if the total values of a vote is valid.

Parameters:

totalValues - the given total values

Returns:

true if the total values of a vote is valid, false otherwhise.

getTotalVoteValueNotValidMessage

String getTotalVoteValueNotValidMessage(Locale locale)

If the total values of a vote is not valid, gets the localized error message.

Parameters:

locale - the locale used to render the error message

Returns:

the localized validation message

isVoteValueNull

boolean isVoteValueNull(Integer value)

Tests if a given vote value is null or not.

Parameters:

value - the vote value to test

Returns:

true if the given vote value is null (or considered as null), false otherwise.

getVoteValueEditorType

ChoiceToVoteRenderType getVoteValueEditorType()

Gets the type of editor used to render a vote value.

Returns:

the type of editor used to render a vote value.

See Also:

ChoiceToVoteRenderType

isDisplayResultsByChoice

@Deprecated
boolean isDisplayResultsByChoice()

Deprecated. since 1.5 (result will be offered by the strategy it-self).

Returns:

true if display results by choice.