edu.usc.ict.iago.views

Class Competition2018GameSpecPart1

java.lang.Object

edu.usc.ict.iago.utils.GameSpec

edu.usc.ict.iago.views.Competition2018GameSpecPart1

class Competition2018GameSpecPart1
extends GameSpec

Constructor Summary

Constructors

Constructor and Description
Competition2018GameSpecPart1(boolean privileged)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	buildMenu() This builds the menu according the JSP rules.
java.lang.String	getEndgameMessage() Provides a description for the system endgame message.
java.lang.String[]	getIssueNames() Returns an array, of length equal to the number of issues, of the natural language names of the issues in singular form
java.lang.String[]	getIssuePluralNames() Returns an array, of length equal to the number of issues, of the natural language names of the issues in plural form
int[]	getIssueQuants() Returns an array, of length equal to the number of issues, that describes how many items are involved in each issue of the multi-issue-bargaining task
int	getNumIssues() Returns a single integer describing how many issues are involved in the multi-issue-bargaining task.
java.lang.String	getStudyName() This returns the user-readable name of the study, which helps to collate results for analysis.
java.lang.String	getSurvey() This returns the URL for the between-game survey
java.lang.String	getTargetEmail() Gets the target email for sending data to.
int	getTotalTime() Returns the total time of the negotiation, in seconds.
boolean	isAdvancedPoints() Returns true if the advanced point scheme is being used, rather than the simple scheme
boolean	showNegotiationTimer() if this method returns true, then the negotiation time remaining will be displayed.
boolean	showOpponentScoreOnEnd() If this method returns true, then the agent score will be shown to the player after the negotiation has ended.

Methods inherited from class edu.usc.ict.iago.utils.GameSpec

enablePrivilege, getAdvancedOpponentPoints, getAdvancedPoints, getAdvancedUserPoints, getBATNA, getMenu, getMultiplier, getNewgameMessage, getOpponentBATNA, getOverflowSize, getPlayerBATNA, getPreference, getRedirectLink, getSimpleOpponentPoints, getSimplePoints, getSimpleUserPoints, isMultiAgent, isUserBlind, setAdvancedOpponentPoints, setAdvancedUserPoints, setIndexMenu, setMultiAgent, setOpponentBATNA, setSimpleOpponentPoints, setSimpleUserPoints, setUserBATNA, showOpponentScore

Methods inherited from class java.lang.Object

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

Constructor Detail

Competition2018GameSpecPart1

Competition2018GameSpecPart1(boolean privileged)

Method Detail

buildMenu

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> buildMenu()

Description copied from class: GameSpec

This builds the menu according the JSP rules. You can override this at your leisure, but only a privileged call to setIndexMenu with the index menu will make an actual change. Note that the youLike and iLike menus are built-in automatically, as are 21 butExpls (0-20). You may create 3 top-level menus using butCustom1, 2, and 3. Each of these may have 3 sub-menus using butCustom1_1, 1_2, 1_3, etc. See default implementation for details.

Overrides:

buildMenu in class GameSpec

getNumIssues

public int getNumIssues()

Description copied from class: GameSpec

Returns a single integer describing how many issues are involved in the multi-issue-bargaining task.

Specified by:

getNumIssues in class GameSpec

Returns:

the number of issues

getIssueQuants

public int[] getIssueQuants()

Description copied from class: GameSpec

Returns an array, of length equal to the number of issues, that describes how many items are involved in each issue of the multi-issue-bargaining task

Specified by:

getIssueQuants in class GameSpec

Returns:

the array of item numbers

getIssuePluralNames

public java.lang.String[] getIssuePluralNames()

Description copied from class: GameSpec

Returns an array, of length equal to the number of issues, of the natural language names of the issues in plural form

Specified by:

getIssuePluralNames in class GameSpec

Returns:

the array of names

getIssueNames

public java.lang.String[] getIssueNames()

Description copied from class: GameSpec

Returns an array, of length equal to the number of issues, of the natural language names of the issues in singular form

Specified by:

getIssueNames in class GameSpec

Returns:

the array of names

isAdvancedPoints

public boolean isAdvancedPoints()

Description copied from class: GameSpec

Returns true if the advanced point scheme is being used, rather than the simple scheme

Overrides:

isAdvancedPoints in class GameSpec

Returns:

whether the advanced point scheme is used or not

getTotalTime

public int getTotalTime()

Description copied from class: GameSpec

Returns the total time of the negotiation, in seconds.

Overrides:

getTotalTime in class GameSpec

Returns:

the total time allotted

getTargetEmail

public java.lang.String getTargetEmail()

Description copied from class: GameSpec

Gets the target email for sending data to. Should be set to a constant string.

Specified by:

getTargetEmail in class GameSpec

Returns:

the target email (used by GameBridgeUtils)

getEndgameMessage

public java.lang.String getEndgameMessage()

Description copied from class: GameSpec

Provides a description for the system endgame message. This may be something like "Thank you for playing, please complete the survey at www.survey.com" Additionally, the game end details will be provided by default (e.g., if the game ended due to timeout, final scores, etc.). The message should be formatted as HTML.

Overrides:

getEndgameMessage in class GameSpec

Returns:

HTML endgame message.

showOpponentScoreOnEnd

public boolean showOpponentScoreOnEnd()

Description copied from class: GameSpec

If this method returns true, then the agent score will be shown to the player after the negotiation has ended.

Overrides:

showOpponentScoreOnEnd in class GameSpec

Returns:

whether the opponent's score is shown or not

showNegotiationTimer

public boolean showNegotiationTimer()

Description copied from class: GameSpec

if this method returns true, then the negotiation time remaining will be displayed.

Overrides:

showNegotiationTimer in class GameSpec

Returns:

whether the negotiation time remaining is shown or not

getStudyName

public java.lang.String getStudyName()

Description copied from class: GameSpec

This returns the user-readable name of the study, which helps to collate results for analysis.

Specified by:

getStudyName in class GameSpec

Returns:

the name of the study (e.g., "MyNewStudy1")

getSurvey

public java.lang.String getSurvey()

Description copied from class: GameSpec

This returns the URL for the between-game survey

Overrides:

getSurvey in class GameSpec

Returns:

the URL of the survey