GameSpec

java.lang.Object
- edu.usc.ict.iago.utils.GameSpec

Direct Known Subclasses:

Competition2018GameSpecPart1, Competition2018GameSpecPart2, Competition2018GameSpecPart3, ResourceGameSpec
```
public abstract class GameSpec
extends java.lang.Object
```
This abstract class describes the publicly available information that must be made available to Users.

Author:

mell

Field Summary

Fields
Modifier and Type Field and Description

(package private) java.util.Properties properties

Fields
Modifier and Type	Field and Description
`(package private) java.util.Properties`	`properties`

Constructor Summary

Constructors
Constructor and Description

GameSpec()

Constructors
Constructor and Description
`GameSpec()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
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.
`protected void`	`enablePrivilege()` This enables privileged information for this instance of the class.
`java.util.Map<java.util.LinkedList<java.lang.Integer>,java.lang.Integer>`	`getAdvancedOpponentPoints()` Returns a mapping of issues to points for the opponent VH.
`java.util.Map<java.util.LinkedList<java.lang.Integer>,java.lang.Integer>`	`getAdvancedPoints(int ID)` Returns a mapping of issues to points for the player matching the input ID.
`java.util.Map<java.util.LinkedList<java.lang.Integer>,java.lang.Integer>`	`getAdvancedUserPoints()` Returns a mapping of issues to points for the user or the user's VH.
`int`	`getBATNA(int ID)` Returns the caller's BATNA (determined by the player's ID as input)
`java.lang.String`	`getEndgameMessage()` Provides a description for the system endgame message.
`abstract 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
`abstract 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
`abstract 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
`java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>`	`getMenu()` Returns a mapping of menu titles to a secondary mapping of sub menus.
`double`	`getMultiplier()` Returns the multiplier for delays in agent responses.
`java.lang.String`	`getNewgameMessage()` Provides a description for the system newgame message.
`abstract int`	`getNumIssues()` Returns a single integer describing how many issues are involved in the multi-issue-bargaining task.
`int`	`getOpponentBATNA()` Returns the opponent VH's BATNA
`int`	`getOverflowSize()` Deprecated.
`int`	`getPlayerBATNA()` Returns the user's BATNA Should return null if access to this information is denied.
`Preference`	`getPreference(int issue1, int issue2, int ID)` Returns a preference relationship between input items for a specified player
`java.lang.String`	`getRedirectLink()` This function will automatically provide a link to the redirect link (e.g.
`java.util.Map<java.lang.String,java.lang.Integer>`	`getSimpleOpponentPoints()` Returns a mapping of issue names to point values for the opponent VH.
`java.util.Map<java.lang.String,java.lang.Integer>`	`getSimplePoints(int ID)` Returns a mapping of issue names to point values for the player matching the input ID.
`java.util.Map<java.lang.String,java.lang.Integer>`	`getSimpleUserPoints()` Returns a mapping of issue names to point values for the user or the user's VH.
`abstract 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
`abstract 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`	`isMultiAgent()` Returns whether or not the negotiation is agent-agent or human-agent.
`boolean`	`isUserBlind()` Returns whether the agent can view the user payoffs or not.
`protected void`	`setAdvancedOpponentPoints(java.util.Map<java.util.LinkedList<java.lang.Integer>,java.lang.Integer> points)` Used to set the advanced Opponent points.
`protected void`	`setAdvancedUserPoints(java.util.Map<java.util.LinkedList<java.lang.Integer>,java.lang.Integer> points)` Used to set the advanced User points.
`protected void`	`setIndexMenu(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> index)` Used to set the root menu.
`void`	`setMultiAgent(boolean isMultiAgent)` Sets whether or not the negotiation is multi-agent.
`protected void`	`setOpponentBATNA(int batna)` Used to set the opponent VH's BATNA.
`protected void`	`setSimpleOpponentPoints(java.util.Map<java.lang.String,java.lang.Integer> points)` Used to set the simple Opponent points.
`protected void`	`setSimpleUserPoints(java.util.Map<java.lang.String,java.lang.Integer> points)` Used to set the simple User points.
`protected void`	`setUserBATNA(int batna)` Used to set the User's BATNA.
`boolean`	`showNegotiationTimer()` if this method returns true, then the negotiation time remaining will be displayed.
`boolean`	`showOpponentScore()` Returns whether the user can view the opponent's payoffs or not.
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - properties
```
java.util.Properties properties
```
- Constructor Detail
  - GameSpec
```
public GameSpec()
```
- Method Detail
  - getAdvancedOpponentPoints
```
public final java.util.Map<java.util.LinkedList<java.lang.Integer>,java.lang.Integer> getAdvancedOpponentPoints()
```
    Returns a mapping of issues to points for the opponent VH.
    
    Returns:
    
    the mapping of issues to points
  - getAdvancedUserPoints
```
public final java.util.Map<java.util.LinkedList<java.lang.Integer>,java.lang.Integer> getAdvancedUserPoints()
                                                                                                     throws java.lang.SecurityException
```
    Returns a mapping of issues to points for the user or the user's VH. Should return null if access to this information is denied.
    
    Returns:
    
    the mapping of issues to points
    
    Throws:
    
    java.lang.SecurityException
  - getAdvancedPoints
```
public final java.util.Map<java.util.LinkedList<java.lang.Integer>,java.lang.Integer> getAdvancedPoints(int ID)
```
    Returns a mapping of issues to points for the player matching the input ID. Used when playing a 2-agent game
    
    Returns:
    
    the mapping of issues to points
  - getSimpleOpponentPoints
```
public final java.util.Map<java.lang.String,java.lang.Integer> getSimpleOpponentPoints()
```
    Returns a mapping of issue names to point values for the opponent VH. This means all point values must be linear (no grouping effects).
    
    Returns:
    
    the mapping of issues to points
  - getSimpleUserPoints
```
public final java.util.Map<java.lang.String,java.lang.Integer> getSimpleUserPoints()
                                                                            throws java.lang.SecurityException
```
    Returns a mapping of issue names to point values for the user or the user's VH. This means all point values must be linear (no grouping effects). Should return null if access to this information is denied. Throws exception if agent attempts to access when security settings would prevent it.
    
    Returns:
    
    the mapping of issues to points
    
    Throws:
    
    java.lang.SecurityException
  - getSimplePoints
```
public final java.util.Map<java.lang.String,java.lang.Integer> getSimplePoints(int ID)
```
    Returns a mapping of issue names to point values for the player matching the input ID. Used when playing a 2-agent game.
    
    Returns:
    
    the mapping of issues to points for the appropriate player
  - getOpponentBATNA
```
public final int getOpponentBATNA()
```
    Returns the opponent VH's BATNA
    
    Returns:
    
    the opponent's BATNA
  - getPlayerBATNA
```
public final int getPlayerBATNA()
                         throws java.lang.SecurityException
```
    Returns the user's BATNA Should return null if access to this information is denied. Throws exception if agent attempts to access when security settings would prevent it.
    
    Returns:
    
    the user's BATNA
    
    Throws:
    
    java.lang.SecurityException
  - getBATNA
```
public final int getBATNA(int ID)
```
    Returns the caller's BATNA (determined by the player's ID as input)
    
    Parameters:
    
    ID - the ID of the method's caller
    
    Returns:
    
    that player's BATNA
  - isMultiAgent
```
public boolean isMultiAgent()
```
    Returns whether or not the negotiation is agent-agent or human-agent.
    
    Returns:
    
    true if the negotiation is agent-agent. false if the negotiation is human-agent.
  - setMultiAgent
```
public void setMultiAgent(boolean isMultiAgent)
```
    Sets whether or not the negotiation is multi-agent.
    
    Parameters:
    
    isMultiAgent - true if agent0 is not null. false if agent0 is null.
  - getMultiplier
```
public double getMultiplier()
```
    Returns the multiplier for delays in agent responses. If the negotiation is multiAgent, then the multiplier will be larger in order to slow down the negotiation.
    
    Returns:
    
    the amount that the delay will be multiplied by.
  - getMenu
```
public final java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getMenu()
```
    Returns a mapping of menu titles to a secondary mapping of sub menus. Any submenus map from title to content.
    
    Returns:
    
    a double mapping of root menu titles to secondary menus.
  - getPreference
```
public Preference getPreference(int issue1,
                                int issue2,
                                int ID)
```
    Returns a preference relationship between input items for a specified player
    
    Parameters:
    
    issue1 -
    
    issue2 -
    
    ID - the ID of the user whose preference will be returned
    
    Returns:
    
    a preference composed of the input issues based on player identified by the ID value
  - getNumIssues
```
public abstract int getNumIssues()
```
    Returns a single integer describing how many issues are involved in the multi-issue-bargaining task.
    
    Returns:
    
    the number of issues
  - getIssueQuants
```
public abstract 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
    
    Returns:
    
    the array of item numbers
  - getIssuePluralNames
```
public abstract 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
    
    Returns:
    
    the array of names
  - getIssueNames
```
public abstract 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
    
    Returns:
    
    the array of names
  - isAdvancedPoints
```
public boolean isAdvancedPoints()
```
    Returns true if the advanced point scheme is being used, rather than the simple scheme
    
    Returns:
    
    whether the advanced point scheme is used or not
  - getTotalTime
```
public int getTotalTime()
```
    Returns the total time of the negotiation, in seconds.
    
    Returns:
    
    the total time allotted
  - isUserBlind
```
public boolean isUserBlind()
```
    Returns whether the agent can view the user payoffs or not.
    
    Returns:
    
    True if agent will trigger a SecurityException on get_PlayerPoints().
  - showOpponentScore
```
public boolean showOpponentScore()
```
    Returns whether the user can view the opponent's payoffs or not.
    
    Returns:
    
    True if the opponent agent's payoffs are visible.
  - getTargetEmail
```
public abstract java.lang.String getTargetEmail()
```
    Gets the target email for sending data to. Should be set to a constant string.
    
    Returns:
    
    the target email (used by GameBridgeUtils)
  - getEndgameMessage
```
public java.lang.String getEndgameMessage()
```
    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.
    
    Returns:
    
    HTML endgame message.
  - getNewgameMessage
```
public java.lang.String getNewgameMessage()
```
    Provides a description for the system newgame message. This may be something like "Welcome to the next round. In this round, you want Bananas the most!" The message should be formatted as HTML.
    
    Returns:
    
    HTML newgame message.
  - showOpponentScoreOnEnd
```
public boolean showOpponentScoreOnEnd()
```
    If this method returns true, then the agent score will be shown to the player after the negotiation has ended.
    
    Returns:
    
    whether the opponent's score is shown or not
  - showNegotiationTimer
```
public boolean showNegotiationTimer()
```
    if this method returns true, then the negotiation time remaining will be displayed.
    
    Returns:
    
    whether the negotiation time remaining is shown or not
  - getRedirectLink
```
public java.lang.String getRedirectLink()
```
    This function will automatically provide a link to the redirect link (e.g. Qualtrics). Note that a user ID will be passed as at GET argument "id" and any condition info will be passed as "condition". WARNING: GET parameters ARE visble to users, so make sure your condition is obfuscated.
    
    Returns:
    
    an http/s formatted string of the url to redirect to
  - getOverflowSize
```
@Deprecated
public int getOverflowSize()
```
    Deprecated.
  - getStudyName
```
public abstract java.lang.String getStudyName()
```
    This returns the user-readable name of the study, which helps to collate results for analysis.
    
    Returns:
    
    the name of the study (e.g., "MyNewStudy1")
  - getSurvey
```
public java.lang.String getSurvey()
```
    This returns the URL for the between-game survey
    
    Returns:
    
    the URL of the survey
  - buildMenu
```
public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> buildMenu()
```
    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.
  - enablePrivilege
```
protected final void enablePrivilege()
```
    This enables privileged information for this instance of the class. Privileged.
  - setOpponentBATNA
```
protected final void setOpponentBATNA(int batna)
```
    Used to set the opponent VH's BATNA. Privileged.
    
    Parameters:
    
    batna - The numerical value of the BATNA
  - setUserBATNA
```
protected final void setUserBATNA(int batna)
```
    Used to set the User's BATNA. Privileged.
    
    Parameters:
    
    batna - The numerical value of the BATNA
  - setSimpleUserPoints
```
protected final void setSimpleUserPoints(java.util.Map<java.lang.String,java.lang.Integer> points)
```
    Used to set the simple User points. Privileged.
    
    Parameters:
    
    points -
  - setSimpleOpponentPoints
```
protected final void setSimpleOpponentPoints(java.util.Map<java.lang.String,java.lang.Integer> points)
```
    Used to set the simple Opponent points. Privileged.
    
    Parameters:
    
    points -
  - setAdvancedUserPoints
```
protected final void setAdvancedUserPoints(java.util.Map<java.util.LinkedList<java.lang.Integer>,java.lang.Integer> points)
```
    Used to set the advanced User points. Privileged.
    
    Parameters:
    
    points -
  - setAdvancedOpponentPoints
```
protected final void setAdvancedOpponentPoints(java.util.Map<java.util.LinkedList<java.lang.Integer>,java.lang.Integer> points)
```
    Used to set the advanced Opponent points. Privileged.
    
    Parameters:
    
    points -
  - setIndexMenu
```
protected final void setIndexMenu(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> index)
```
    Used to set the root menu. Privileged.
    
    Parameters:
    
    points -

Class GameSpec

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

properties

Constructor Detail

GameSpec

Method Detail

getAdvancedOpponentPoints

getAdvancedUserPoints

getAdvancedPoints

getSimpleOpponentPoints

getSimpleUserPoints

getSimplePoints

getOpponentBATNA

getPlayerBATNA

getBATNA

isMultiAgent

setMultiAgent

getMultiplier

getMenu

getPreference

getNumIssues

getIssueQuants

getIssuePluralNames

getIssueNames

isAdvancedPoints

getTotalTime

isUserBlind

showOpponentScore

getTargetEmail

getEndgameMessage

getNewgameMessage

showOpponentScoreOnEnd

showNegotiationTimer

getRedirectLink

getOverflowSize

getStudyName

getSurvey

buildMenu

enablePrivilege

setOpponentBATNA

setUserBATNA

setSimpleUserPoints

setSimpleOpponentPoints

setAdvancedUserPoints

setAdvancedOpponentPoints

setIndexMenu