org.chorem.pollen.votecounting

Interface VoteCounting<S extends VoteCountingStrategy>

All Known Implementing Classes:

AbstractVoteCounting

public interface VoteCounting<S extends VoteCountingStrategy>

Contract of a vote counting.

Since:

1.6

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	getHelp(Locale locale) Get the vote counting strategy help to display in UI.
int	getId() Obtains the unique id of this strategy.
String	getName(Locale locale) Get the vote counting strategy name to display in UI.
String	getShortHelp(Locale locale) Get the vote counting short help 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, String choiceName, String voteValue) 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	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.
S	newStrategy() Obtains a fresh instance of a vote coutning strategy.

Method Detail

newStrategy

S newStrategy()

Obtains a fresh instance of a vote coutning strategy.

Returns:

a new instance of vote counting strategy for this type of vote counting.

getId

int getId()

Obtains the unique id of this strategy.

Returns:

the unique id of this strategy.

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.

getName

String getName(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

getShortHelp

String getShortHelp(Locale locale)

Get the vote counting short help to display in UI.

Parameters:

locale - the locale used to render the strategy name

Returns:

the localized vote counting short help

getHelp

String getHelp(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,
                                 String choiceName,
                                 String voteValue)

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

Parameters:

locale - the locale used to render the error message

choiceName - name of thechoice

voteValue - value fo the vote

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