com.thebluealliance.api.v3.requests

Class DistrictRequest

java.lang.Object

com.thebluealliance.api.v3.requests.DistrictRequest

public class DistrictRequest
extends java.lang.Object

Makes requests with district-specific information

Constructor Summary

Constructors

Constructor and Description
DistrictRequest(DataRequest tba) Creates a DistrictRequest object

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getEventKeys(java.lang.String districtKey) Makes API requests with the subdirectory /district/{districtKey}/events/keys
Event[]	getEvents(java.lang.String districtKey) Makes API requests with the subdirectory /district/{districtKey}/events
DistrictRanking[]	getRankings(java.lang.String districtKey) Makes API requests with the subdirectory /district/{districtKey}/rankings
SimpleEvent[]	getSimpleEvents(java.lang.String districtKey) Makes API requests with the subdirectory /district/{districtKey}/events/simple
SimpleTeam[]	getSimpleTeams(java.lang.String districtKey) Makes API requests with the subdirectory /district/{districtKey}/teams/simple
java.lang.String[]	getTeamKeys(java.lang.String districtKey) Makes API requests with the subdirectory /district/{districtKey}/teams/keys
Team[]	getTeams(java.lang.String districtKey) Makes API requests with the subdirectory /district/{districtKey}/teams

Methods inherited from class java.lang.Object

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

Constructor Detail

DistrictRequest

public DistrictRequest(DataRequest tba)

Creates a DistrictRequest object

Parameters:

tba - A DataRequest object with the appropriate auth key

Method Detail

getTeams

public Team[] getTeams(java.lang.String districtKey)
                throws java.io.IOException

Makes API requests with the subdirectory /district/{districtKey}/teams

Parameters:

districtKey - TBA District Key, e.g. 2016fim

Returns:

A list of Team objects in the given district

Throws:

java.io.IOException

getSimpleTeams

public SimpleTeam[] getSimpleTeams(java.lang.String districtKey)
                            throws java.io.IOException

Makes API requests with the subdirectory /district/{districtKey}/teams/simple

Parameters:

districtKey - TBA District Key, e.g. 2016fim

Returns:

A list of SimpleTeam objects in the given district

Throws:

java.io.IOException

getTeamKeys

public java.lang.String[] getTeamKeys(java.lang.String districtKey)
                               throws java.io.IOException

Makes API requests with the subdirectory /district/{districtKey}/teams/keys

Parameters:

districtKey - TBA District Key, e.g. 2016fim

Returns:

A list of team keys in the given district

Throws:

java.io.IOException

getRankings

public DistrictRanking[] getRankings(java.lang.String districtKey)
                              throws java.io.IOException

Makes API requests with the subdirectory /district/{districtKey}/rankings

Parameters:

districtKey - TBA District Key, e.g. 2016fim

Returns:

A list of team DistrictRankings for the given district

Throws:

java.io.IOException

getEvents

public Event[] getEvents(java.lang.String districtKey)
                  throws java.io.IOException

Makes API requests with the subdirectory /district/{districtKey}/events

Parameters:

districtKey - TBA District Key, e.g. 2016fim

Returns:

A list of events in the given district

Throws:

java.io.IOException

getSimpleEvents

public SimpleEvent[] getSimpleEvents(java.lang.String districtKey)
                              throws java.io.IOException

Makes API requests with the subdirectory /district/{districtKey}/events/simple

Parameters:

districtKey - TBA District Key, e.g. 2016fim

Returns:

A short-form list of events in the given district

Throws:

java.io.IOException

getEventKeys

public java.lang.String[] getEventKeys(java.lang.String districtKey)
                                throws java.io.IOException

Makes API requests with the subdirectory /district/{districtKey}/events/keys

Parameters:

districtKey - TBA District Key, e.g. 2016fim

Returns:

A list of event keys in the given district

Throws:

java.io.IOException