Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface PollManager

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

Polls

public interface PollManager
extends CMLibrary

All encompassing Polling library, which handles not only caching fully loaded polls, but accessing polls from the database, creating them, editing them, participating in them, and seeing the results of them. Everything!

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Method Summary

Modifier and Type	Method	Description
void	addPoll(Poll P)	Given a Poll object, this will add it to the memory cache -- that is all.
void	createPoll(Poll P)	Given a fully populated Poll object, this will create the Poll in the database, and add it to the cache.
void	deletePoll(Poll P)	Given a Poll object with a name filled in, this will delete the Poll from the database and remove it from the cache.
java.util.List<Poll>[]	getMyPollTypes(MOB mob, boolean login)	Returns polls divided into three groups as three list objects: 0 - Polls the given mob can vote in 1 - If during logic, polls the mob can't vote it during login 2 - Polls the given mob can see results of
Poll	getPoll(int x)	Given a 0-bound number, this will return a poll with the same ordinal as it appeared in getPollList
Poll	getPoll(java.lang.String named)	Given a poll name, this will return the poll with that name, loading it fully from the database if necessary.
java.util.Iterator<Poll>	getPollList()	Returns a complete list of all database polls.
Poll	loadPollByName(java.lang.String name)	Given the name of a poll, this will attempt to load it from the database and return the fully populated Poll object.
boolean	loadPollIfNecessary(Poll P)	Given a Poll object which might contain nothing more than a name, this will load the entirety of the Poll object, if necessary.
void	modifyVote(Poll P, MOB mob)	Given a Poll object fully loaded, and a archon-ish mob, this will allow the settings of the poll to be edited.
void	processResults(Poll P, MOB mob)	Given a Poll object with as little as a name, and a player mob, this will show the results of the poll to the given user, possibly loading the Poll in the process.
void	processVote(Poll P, MOB mob)	Given a Poll object with as little as a name, and a player mob, this will allow the mob to vote in the poll, possibly loading the poll fully in the process.
void	removePoll(Poll P)	Given a Poll object that might be cached, this will remove the object from the cache.
void	updatePoll(java.lang.String oldName, Poll P)	Given the name of an existing Poll in the database, and a Poll object, this will update the database entry accordingly
void	updatePollResults(Poll P)	Given an existing Poll in the database that has new Poll Results added to it, this will update those results in the database.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getMyPollTypes

java.util.List<Poll>[] getMyPollTypes(MOB mob,
                                      boolean login)

Returns polls divided into three groups as three list objects: 0 - Polls the given mob can vote in 1 - If during logic, polls the mob can't vote it during login 2 - Polls the given mob can see results of

Parameters:

mob - the player for whom polls are required

login - true if requested during login, false otherwise

Returns:

the 3 poll lists

See Also:

getPoll(String), getPoll(int), getPollList()

getPoll

Poll getPoll(java.lang.String named)

Given a poll name, this will return the poll with that name, loading it fully from the database if necessary.

Parameters:

named - the name of the poll

Returns:

null, or the Poll object

See Also:

getPoll(String), getPoll(int), getPollList(), getMyPollTypes(MOB, boolean)

getPoll

Poll getPoll(int x)

Given a 0-bound number, this will return a poll with the same ordinal as it appeared in getPollList

Parameters:

x - the 0 based ordinal

Returns:

the Poll object or null

See Also:

getPoll(String), getPoll(int), getPollList(), getMyPollTypes(MOB, boolean)

getPollList

java.util.Iterator<Poll> getPollList()

Returns a complete list of all database polls. The cached ones will be filled in, and the remainder might be nothing more than named.

Returns:

an iterator of all poll objects

See Also:

getPoll(String), getPoll(int), getPollList(), getMyPollTypes(MOB, boolean)

processVote

void processVote(Poll P,
                 MOB mob)

Given a Poll object with as little as a name, and a player mob, this will allow the mob to vote in the poll, possibly loading the poll fully in the process.

Parameters:

P - the Poll object

mob - the player who can vote on it

See Also:

modifyVote(Poll, MOB), processResults(Poll, MOB)

modifyVote

void modifyVote(Poll P,
                MOB mob)
         throws java.io.IOException

Given a Poll object fully loaded, and a archon-ish mob, this will allow the settings of the poll to be edited.

Parameters:

P - the Poll object

mob - the player who can edit it

Throws:

java.io.IOException - the ioexception from the mob interaction

See Also:

processVote(Poll, MOB), processResults(Poll, MOB)

processResults

void processResults(Poll P,
                    MOB mob)

Given a Poll object with as little as a name, and a player mob, this will show the results of the poll to the given user, possibly loading the Poll in the process.

Parameters:

P - the Poll object, with maybe just a name

mob - the player to show results to

See Also:

processVote(Poll, MOB), modifyVote(Poll, MOB)

updatePollResults

void updatePollResults(Poll P)

Given an existing Poll in the database that has new Poll Results added to it, this will update those results in the database.

Parameters:

P - the poll with results

See Also:

updatePoll(String, Poll)

updatePoll

void updatePoll(java.lang.String oldName,
                Poll P)

Given the name of an existing Poll in the database, and a Poll object, this will update the database entry accordingly

Parameters:

oldName - the name of an existing poll

P - the poll to update in the database

See Also:

updatePollResults(Poll)

addPoll

void addPoll(Poll P)

Given a Poll object, this will add it to the memory cache -- that is all.

Parameters:

P - the Poll object to cache

See Also:

createPoll(Poll)

createPoll

void createPoll(Poll P)

Given a fully populated Poll object, this will create the Poll in the database, and add it to the cache.

Parameters:

P - the fully populated Poll object

See Also:

addPoll(Poll), loadPollByName(String), loadPollIfNecessary(Poll)

removePoll

void removePoll(Poll P)

Given a Poll object that might be cached, this will remove the object from the cache.

Parameters:

P - the Poll object to de-cache

See Also:

deletePoll(Poll)

deletePoll

void deletePoll(Poll P)

Given a Poll object with a name filled in, this will delete the Poll from the database and remove it from the cache.

Parameters:

P - a Poll object with a name

See Also:

removePoll(Poll)

loadPollByName

Poll loadPollByName(java.lang.String name)

Given the name of a poll, this will attempt to load it from the database and return the fully populated Poll object. Does *not* call addPoll.

Parameters:

name - the name of the poll

Returns:

the Poll object, or null

See Also:

loadPollIfNecessary(Poll), addPoll(Poll)

loadPollIfNecessary

boolean loadPollIfNecessary(Poll P)

Given a Poll object which might contain nothing more than a name, this will load the entirety of the Poll object, if necessary.

Parameters:

P - the Poll object, which might need filling out

Returns:

true if loaded, false if problems

See Also:

loadPollByName(String), addPoll(Poll)