Package com.planet_ink.coffee_mud.Libraries

Class Polls

java.lang.Object

com.planet_ink.coffee_mud.Libraries.StdLibrary

com.planet_ink.coffee_mud.Libraries.Polls

All Implemented Interfaces:

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

public class Polls
extends StdLibrary
implements PollManager

Field Summary

Fields

Modifier and Type	Field	Description
SVector<Poll>	pollCache

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

idConverter

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

isDebugging, name, serviceClient, tickStatus

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

STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors

Constructor	Description
Polls()

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>	getCache()
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.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
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.
boolean	shutdown()	Shuts down the library.
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

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

copyOf, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

activate, checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, initializeClass, L, name, newInstance, propertiesLoaded, setThreadStatus, tick

Field Detail

pollCache

public SVector<Poll> pollCache

Constructor Detail

Polls

public Polls()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class StdLibrary

Returns:

the name of this class

shutdown

public boolean shutdown()

Description copied from interface: CMLibrary

Shuts down the library. Called at system shutdown time obviously, but is sometimes called just to reset the library.

Specified by:

shutdown in interface CMLibrary

Overrides:

shutdown in class StdLibrary

Returns:

true if shutdown was successful, false if there's nothing you can do about it

See Also:

CMLibrary.activate()

addPoll

public void addPoll(Poll P)

Description copied from interface: PollManager

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

Specified by:

addPoll in interface PollManager

Parameters:

P - the Poll object to cache

See Also:

PollManager.createPoll(Poll)

removePoll

public void removePoll(Poll P)

Description copied from interface: PollManager

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

Specified by:

removePoll in interface PollManager

Parameters:

P - the Poll object to de-cache

See Also:

PollManager.deletePoll(Poll)

getCache

public java.util.List<Poll> getCache()

getPoll

public Poll getPoll(java.lang.String named)

Description copied from interface: PollManager

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

Specified by:

getPoll in interface PollManager

Parameters:

named - the name of the poll

Returns:

null, or the Poll object

See Also:

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

getPoll

public Poll getPoll(int x)

Description copied from interface: PollManager

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

Specified by:

getPoll in interface PollManager

Parameters:

x - the 0 based ordinal

Returns:

the Poll object or null

See Also:

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

getMyPollTypes

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

Description copied from interface: PollManager

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

Specified by:

getMyPollTypes in interface PollManager

Parameters:

mob - the player for whom polls are required

login - true if requested during login, false otherwise

Returns:

the 3 poll lists

See Also:

PollManager.getPoll(String), PollManager.getPoll(int), PollManager.getPollList()

getPollList

public java.util.Iterator<Poll> getPollList()

Description copied from interface: PollManager

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

Specified by:

getPollList in interface PollManager

Returns:

an iterator of all poll objects

See Also:

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

processVote

public void processVote(Poll P,
                        MOB mob)

Description copied from interface: PollManager

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.

Specified by:

processVote in interface PollManager

Parameters:

P - the Poll object

mob - the player who can vote on it

See Also:

PollManager.modifyVote(Poll, MOB), PollManager.processResults(Poll, MOB)

modifyVote

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

Description copied from interface: PollManager

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

Specified by:

modifyVote in interface PollManager

Parameters:

P - the Poll object

mob - the player who can edit it

Throws:

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

See Also:

PollManager.processVote(Poll, MOB), PollManager.processResults(Poll, MOB)

processResults

public void processResults(Poll P,
                           MOB mob)

Description copied from interface: PollManager

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.

Specified by:

processResults in interface PollManager

Parameters:

P - the Poll object, with maybe just a name

mob - the player to show results to

See Also:

PollManager.processVote(Poll, MOB), PollManager.modifyVote(Poll, MOB)

createPoll

public void createPoll(Poll P)

Description copied from interface: PollManager

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

Specified by:

createPoll in interface PollManager

Parameters:

P - the fully populated Poll object

See Also:

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

updatePollResults

public void updatePollResults(Poll P)

Description copied from interface: PollManager

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

Specified by:

updatePollResults in interface PollManager

Parameters:

P - the poll with results

See Also:

PollManager.updatePoll(String, Poll)

updatePoll

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

Description copied from interface: PollManager

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

Specified by:

updatePoll in interface PollManager

Parameters:

oldName - the name of an existing poll

P - the poll to update in the database

See Also:

PollManager.updatePollResults(Poll)

deletePoll

public void deletePoll(Poll P)

Description copied from interface: PollManager

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

Specified by:

deletePoll in interface PollManager

Parameters:

P - a Poll object with a name

See Also:

PollManager.removePoll(Poll)

loadPollIfNecessary

public boolean loadPollIfNecessary(Poll P)

Description copied from interface: PollManager

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

Specified by:

loadPollIfNecessary in interface PollManager

Parameters:

P - the Poll object, which might need filling out

Returns:

true if loaded, false if problems

See Also:

PollManager.loadPollByName(String), PollManager.addPoll(Poll)

loadPollByName

public Poll loadPollByName(java.lang.String name)

Description copied from interface: PollManager

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.

Specified by:

loadPollByName in interface PollManager

Parameters:

name - the name of the poll

Returns:

the Poll object, or null

See Also:

PollManager.loadPollIfNecessary(Poll), PollManager.addPoll(Poll)