votorola.a.election.district
Class RegionalScheme.ConfigurationContext

java.lang.Object
  RegionalScheme.ConfigurationContext

Enclosing class:

RegionalScheme

@ThreadSafe
public static final class RegionalScheme.ConfigurationContext
extends Object

A context for configuring a regional scheme. The scheme is configured by its configuration file, which contains a script (s) for that purpose. During construction of the scheme, an instance of this context (schemeCC) is passed to s, via s::configureRegionalScheme(schemeCC).

Method Summary

String	getShortTitle()
String	getSummaryDescription()
String	getTitle()
boolean	isAbstractSingleton()
void	setAbstractSingleton(boolean b) Sets whether or not the scheme is an abstract singleton.
void	setShortTitle(String shortTitle) Sets the short title of the scheme.
void	setSummaryDescription(String summaryDescription) Sets the summary description of the scheme.
void	setTitle(String title) Sets the title of the scheme.

Methods inherited from class java.lang.Object

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

Method Detail

isAbstractSingleton

public final boolean isAbstractSingleton()

See Also:

RegionalScheme.isAbstractSingleton(), setAbstractSingleton(boolean)

setAbstractSingleton

public final void setAbstractSingleton(boolean b)

Sets whether or not the scheme is an abstract singleton.

See Also:

RegionalScheme.isAbstractSingleton()

getShortTitle

public String getShortTitle()

See Also:

RegionalScheme.shortTitle(), setShortTitle(String)

setShortTitle

@ThreadRestricted(value="constructor")
public void setShortTitle(String shortTitle)

Sets the short title of the scheme. The default value is the placeholder "Scheme".

See Also:

RegionalScheme.shortTitle()

getSummaryDescription

public String getSummaryDescription()

See Also:

RegionalScheme.summaryDescription(), setSummaryDescription(String)

setSummaryDescription

@ThreadRestricted(value="constructor")
public void setSummaryDescription(String summaryDescription)

Sets the summary description of the scheme. The default value is a placeholder with configuration instructions for the administrator.

Throws:

IllegalArgumentException - if the description contains any newline characters, because they might render inconsistently across different types of user interface

See Also:

RegionalScheme.summaryDescription()

getTitle

public String getTitle()

See Also:

RegionalScheme.title(), setTitle(String)

setTitle

@ThreadRestricted(value="constructor")
public void setTitle(String title)

Sets the title of the scheme. The default value is the placeholder "Regional Scheme".

See Also:

RegionalScheme.title()