votorola.a.count

Class PollService.ConstructionContext

java.lang.Object

VoterService.ConstructionContext

PollService.ConstructionContext

Enclosing class:

PollService

@ThreadRestricted(value="constructor")
public static final class PollService.ConstructionContext
extends VoterService.ConstructionContext

A context for configuring the construction of a PollService. Each construction is configured by the common configuration script (s). During construction, an instance of this context (pollCC) is passed to s via s::constructingPoll(pollCC).

Method Summary

Methods

Modifier and Type	Method and Description
void	addDivisionalComponent(String div) Adds a division to the set of divisions whose members are exclusively eligible to vote in this poll.
String	getDisplayTitle()
String	getDivisionPageName()
String	getDivisionSmallMapPageName()
String	getIssueType()
long	getPopulationSize()
String	getPopulationSizeExplanation()
String	getSummaryDescription()
String	getWGLogoImageLocation()
String	getWGLogoLinkTarget()
boolean	isReconstruct() Answers whether scratch construction is being attempted, in which cached configuration items are ignored.
void	setDisplayTitle(String _displayTitle) Sets the display title of the poll.
void	setDivisionPageName(String _divisionPageName) Sets the pollwiki pagename of the polling division.
void	setDivisionSmallMapPageName(String _divisionSmallMapPageName) Sets the pollwiki pagename of the polling divisionSmallMap.
void	setIssueType(String _issueType) Sets the issue type of the poll.
void	setPopulationSize(long _populationSize) Sets the population base of this poll.
void	setPopulationSizeExplanation(String _populationSizeExplanation) Sets the explanation of the population base.
void	setSummaryDescription(String _summaryDescription) Sets the summaryDescription of the poll.
void	setWGLogoImageLocation(String _wgLogoImageLocation) Sets the image location for the wiki logo.
void	setWGLogoLinkTarget(String _wgLogoLinkTarget) Sets the link target of the wiki logo.
VoteServer	voteServer() The vote-server.

Methods inherited from class VoterService.ConstructionContext

name, startupConfigurationFile

Methods inherited from class java.lang.Object

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

Method Detail

addDivisionalComponent

public void addDivisionalComponent(String div)

Adds a division to the set of divisions whose members are exclusively eligible to vote in this poll. The default set is empty, meaning that divisional membership is not an eligibility criterion.

Parameters:

div - the pagename of a division as defined in the local pollwiki, or the URL of a remotely defined division

See Also:

PollService.divisionalComponents()

getDisplayTitle

public String getDisplayTitle()

See Also:

PollService.displayTitle(), setDisplayTitle(String)

setDisplayTitle

public void setDisplayTitle(String _displayTitle)

Sets the display title of the poll.

See Also:

PollService.displayTitle()

getDivisionPageName

public String getDivisionPageName()

See Also:

PollService.divisionPageName(), setDivisionPageName(String)

setDivisionPageName

public void setDivisionPageName(String _divisionPageName)

Sets the pollwiki pagename of the polling division. The default value is null, meaning unspecified.

See Also:

PollService.divisionPageName()

getDivisionSmallMapPageName

public String getDivisionSmallMapPageName()

See Also:

PollService.divisionSmallMapPageName(), setDivisionSmallMapPageName(String)

setDivisionSmallMapPageName

public void setDivisionSmallMapPageName(String _divisionSmallMapPageName)

Sets the pollwiki pagename of the polling divisionSmallMap. The default value is null, meaning unspecified.

See Also:

PollService.divisionSmallMapPageName()

getIssueType

public String getIssueType()

See Also:

PollService.issueType(), setIssueType(String)

setIssueType

public void setIssueType(String _issueType)

Sets the issue type of the poll. The default value is "Issue", meaning unspecified.

See Also:

PollService.issueType()

getPopulationSize

public long getPopulationSize()

See Also:

PollService.populationSize(), setPopulationSize(long)

setPopulationSize

public void setPopulationSize(long _populationSize)

Sets the population base of this poll. The default value is zero, meaning unknown.

See Also:

PollService.populationSize()

getPopulationSizeExplanation

public String getPopulationSizeExplanation()

See Also:

PollService.populationSizeExplanation(), setPopulationSizeExplanation(String)

setPopulationSizeExplanation

public void setPopulationSizeExplanation(String _populationSizeExplanation)

Sets the explanation of the population base. The default value is "Estimated number of eligible voters.".

See Also:

PollService.populationSizeExplanation()

voteServer

public VoteServer voteServer()

The vote-server.

getSummaryDescription

public String getSummaryDescription()

See Also:

PollService.summaryDescription(), setSummaryDescription(String)

setSummaryDescription

public void setSummaryDescription(String _summaryDescription)

Sets the summaryDescription of the poll. The default value is a placeholder with configuration instructions for the administrator.

See Also:

PollService.summaryDescription()

getWGLogoImageLocation

public String getWGLogoImageLocation()

See Also:

PollService.wgLogoImageLocation(), setWGLogoImageLocation(String)

setWGLogoImageLocation

public void setWGLogoImageLocation(String _wgLogoImageLocation)

Sets the image location for the wiki logo. The default value is null, meaning unspecified.

See Also:

PollService.wgLogoImageLocation()

getWGLogoLinkTarget

public String getWGLogoLinkTarget()

See Also:

PollService.wgLogoLinkTarget(), setWGLogoLinkTarget(String)

setWGLogoLinkTarget

public void setWGLogoLinkTarget(String _wgLogoLinkTarget)

Sets the link target of the wiki logo. The default value is the base URI of the wiki.

See Also:

PollService.wgLogoLinkTarget()

isReconstruct

public boolean isReconstruct()

Answers whether scratch construction is being attempted, in which cached configuration items are ignored. During scratch construction, scripts are expected to report verbose progress (via 'print' commands) for the benefit of the administrator or user who requested it.