com.thebluealliance.api.v3.requests

Class EventRequest

java.lang.Object

com.thebluealliance.api.v3.requests.EventRequest

public class EventRequest
extends java.lang.Object

Makes requests with event-specific information

Constructor Summary

Constructors

Constructor and Description
EventRequest(DataRequest tba) Creates an EventRequest object

Method Summary

Modifier and Type	Method and Description
EliminationAlliance[]	getAlliances(java.lang.String eventKey) Makes API requests with the subdirectory /event/{eventKey}/alliances
Award[]	getAwards(java.lang.String eventKey) Makes API requests with the subdirectory /event/{eventKey}/awards
EventDistrictPoints	getDistrictPoints(java.lang.String eventKey) Makes API requests with the subdirectory /event/{eventKey}/district_points
Event	getEvent(java.lang.String eventKey) Makes API requests with the subdirectory /event/{eventKey}
java.lang.String[]	getEventKeys(int year) Makes API requests with the subdirectory /events/{year}/keys
Event[]	getEvents(int year) Makes API requests with the subdirectory /events/{year}
Match[]	getMatches(java.lang.String eventKey) Makes API requests with the subdirectory /event/{eventKey}/matches
java.lang.String[]	getMatchKeys(java.lang.String eventKey) Makes API requests with the subdirectory /event/{eventKey}/matches/keys
OPRs	getOPRs(java.lang.String eventKey) Makes API requests with the subdirectory /event/{eventKey}/oprs
EventRankings	getRankings(java.lang.String eventKey) Makes API requests with the subdirectory /event/{eventKey}/rankings
SimpleEvent	getSimpleEvent(java.lang.String eventKey) Makes API requests with the subdirectory /event/{eventKey}/simple
SimpleEvent[]	getSimpleEvents(int year) Makes API requests with the subdirectory /events/{year}/simple
SimpleMatch[]	getSimpleMatches(java.lang.String eventKey) Makes API requests with the subdirectory /event/{eventKey}/matches/simple
SimpleTeam[]	getSimpleTeams(java.lang.String eventKey) Makes API requests with the subdirectory /event/{eventKey}/teams/simple
java.lang.String[]	getTeamKeys(java.lang.String eventKey) Makes API requests with the subdirectory /event/{eventKey}/teams/keys
Team[]	getTeams(java.lang.String eventKey) Makes API requests with the subdirectory /event/{eventKey}/teams

Methods inherited from class java.lang.Object

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

Constructor Detail

EventRequest

public EventRequest(DataRequest tba)

Creates an EventRequest object

Parameters:

tba - A DataRequest object with the appropriate auth key

Method Detail

getEvent

public Event getEvent(java.lang.String eventKey)
               throws java.io.IOException

Makes API requests with the subdirectory /event/{eventKey}

Parameters:

eventKey - TBA Event Key, e.g. 2016nytr

Returns:

The Event object referenced by the given key

Throws:

java.io.IOException

getSimpleEvent

public SimpleEvent getSimpleEvent(java.lang.String eventKey)
                           throws java.io.IOException

Makes API requests with the subdirectory /event/{eventKey}/simple

Parameters:

eventKey - TBA Event Key, e.g. 2016nytr

Returns:

The SimpleEvent object referenced by the given key

Throws:

java.io.IOException

getTeams

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

Makes API requests with the subdirectory /event/{eventKey}/teams

Parameters:

eventKey - TBA Event Key, e.g. 2016nytr

Returns:

A list of Team objects that competed in the given event.

Throws:

java.io.IOException

getSimpleTeams

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

Makes API requests with the subdirectory /event/{eventKey}/teams/simple

Parameters:

eventKey - TBA Event Key, e.g. 2016nytr

Returns:

A list of SimpleTeam objects that competed in the given event.

Throws:

java.io.IOException

getTeamKeys

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

Makes API requests with the subdirectory /event/{eventKey}/teams/keys

Parameters:

eventKey - TBA Event Key, e.g. 2016nytr

Returns:

A list of Team keys that competed in the given event.

Throws:

java.io.IOException

getEvents

public Event[] getEvents(int year)
                  throws java.io.IOException

Makes API requests with the subdirectory /events/{year}

Parameters:

year - Competition year (or season). Must be four digits.

Returns:

A list of Event objects that occurred in a given year

Throws:

java.io.IOException

getSimpleEvents

public SimpleEvent[] getSimpleEvents(int year)
                              throws java.io.IOException

Makes API requests with the subdirectory /events/{year}/simple

Parameters:

year - Competition year (or season). Must be four digits.

Returns:

A list of SimpleEvent objects that occurred in a given year

Throws:

java.io.IOException

getEventKeys

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

Makes API requests with the subdirectory /events/{year}/keys

Parameters:

year - Competition year (or season). Must be four digits.

Returns:

A list of Event keys that occurred in a given year

Throws:

java.io.IOException

getDistrictPoints

public EventDistrictPoints getDistrictPoints(java.lang.String eventKey)
                                      throws java.io.IOException

Makes API requests with the subdirectory /event/{eventKey}/district_points

Parameters:

eventKey - TBA Event Key, e.g. 2016nytr

Returns:

A list of team rankings for the event

Throws:

java.io.IOException

getAlliances

public EliminationAlliance[] getAlliances(java.lang.String eventKey)
                                   throws java.io.IOException

Makes API requests with the subdirectory /event/{eventKey}/alliances

Parameters:

eventKey - TBA Event Key, e.g. 2016nytr

Returns:

A list of EliminationAlliances for the event

Throws:

java.io.IOException

getOPRs

public OPRs getOPRs(java.lang.String eventKey)
             throws java.io.IOException

Makes API requests with the subdirectory /event/{eventKey}/oprs

Parameters:

eventKey - TBA Event Key, e.g. 2016nytr

Returns:

A set of OPRs (includeing OPR, DPR, and CCWM) for the event

Throws:

java.io.IOException

getRankings

public EventRankings getRankings(java.lang.String eventKey)
                          throws java.io.IOException

Makes API requests with the subdirectory /event/{eventKey}/rankings

Parameters:

eventKey - TBA Event Key, e.g. 2016nytr

Returns:

A list of team rankings for the event

Throws:

java.io.IOException

getMatches

public Match[] getMatches(java.lang.String eventKey)
                   throws java.io.IOException

Makes API requests with the subdirectory /event/{eventKey}/matches

Parameters:

eventKey - TBA Event Key, e.g. 2016nytr

Returns:

A list of Matches for the event

Throws:

java.io.IOException

getSimpleMatches

public SimpleMatch[] getSimpleMatches(java.lang.String eventKey)
                               throws java.io.IOException

Makes API requests with the subdirectory /event/{eventKey}/matches/simple

Parameters:

eventKey - TBA Event Key, e.g. 2016nytr

Returns:

A list of SimpleMatches for the event

Throws:

java.io.IOException

getMatchKeys

public java.lang.String[] getMatchKeys(java.lang.String eventKey)
                                throws java.io.IOException

Makes API requests with the subdirectory /event/{eventKey}/matches/keys

Parameters:

eventKey - TBA Event Key, e.g. 2016nytr

Returns:

A list of match keys for the event

Throws:

java.io.IOException

getAwards

public Award[] getAwards(java.lang.String eventKey)
                  throws java.io.IOException

Makes API requests with the subdirectory /event/{eventKey}/awards

Parameters:

eventKey - TBA Event Key, e.g. 2016nytr

Returns:

A list of Awards from the given the event

Throws:

java.io.IOException