Package com.treescrub.spedran.data

Class Category

java.lang.Object

com.treescrub.spedran.data.Resource

com.treescrub.spedran.data.IdentifiableResource

com.treescrub.spedran.data.IdentifiableNamedResource

com.treescrub.spedran.data.Category

public class Category
extends IdentifiableNamedResource

A category of runs which has its own specific rules.
Common category names are Any%, 100%, and so on.

This class is immutable and thread-safe.

Method Summary

Modifier and Type	Method	Description
CategoryPlayers	getPlayers()	Gets the player count restriction for this category.
CategoryRecordsRequest	getRecords()	Gets a new CategoryRecordsRequest builder object to request records for this category.
String	getRules()	Gets the moderator defined rules text for this category.
RunsRequest	getRuns()	Gets a new RunsRequest builder object to request all runs in this category.
CategoryVariablesRequest	getVariables()	Gets a new CategoryVariablesRequest builder object to request variables for this category.
String	getWeblink()	Gets the link to this category on SRC.
boolean	isMiscellaneous()	Is this category considered a miscellaneous category.
boolean	isPerLevel()	If true, this category has specific levels, otherwise this category does not have levels.
String	toString()

Methods inherited from class com.treescrub.spedran.data.IdentifiableNamedResource

getName

Methods inherited from class com.treescrub.spedran.data.IdentifiableResource

equals, getId, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getRuns

public RunsRequest getRuns()

Gets a new RunsRequest builder object to request all runs in this category.

Returns:

a RunsRequest builder

getRecords

public CategoryRecordsRequest getRecords()

Gets a new CategoryRecordsRequest builder object to request records for this category.

Returns:

a CategoryRecordsRequest builder

getVariables

public CategoryVariablesRequest getVariables()

Gets a new CategoryVariablesRequest builder object to request variables for this category.

Returns:

a CategoryVariablesRequest builder

getWeblink

public String getWeblink()

Gets the link to this category on SRC.
SRC API currently returns a link that does not work!

Returns:

a link to the category on SRC

isPerLevel

public boolean isPerLevel()

If true, this category has specific levels, otherwise this category does not have levels.

Returns:

true if this category is per level, otherwise false

getRules

public String getRules()

Gets the moderator defined rules text for this category.

Returns:

rules text

getPlayers

public CategoryPlayers getPlayers()

Gets the player count restriction for this category.

Returns:

a CategoryPlayers

isMiscellaneous

public boolean isMiscellaneous()

Is this category considered a miscellaneous category.

Returns:

is miscellaneous

toString

public String toString()

Overrides:

toString in class Object