com.thebluealliance.api.v3.requests

Class TeamRequest

java.lang.Object

com.thebluealliance.api.v3.requests.TeamRequest

public class TeamRequest
extends java.lang.Object

Makes requests with team-specific information

Constructor Summary

Constructors

Constructor and Description
TeamRequest(DataRequest dataRequest) Creates a TeamRequest object

Method Summary

Modifier and Type	Method and Description
Award[]	getAwards(int teamNumber) Makes API requests with the subdirectory /team/frc{teamNumber}/awards
Award[]	getAwards(int teamNumber, int year) Makes API requests with the subdirectory /team/frc{teamNumber}/awards/{year}
Award[]	getAwards(int teamNumber, java.lang.String eventKey) Makes API requests with the subdirectory /team/frc{teamNumber}/event/{eventKey}/awards
District[]	getDistricts(int teamNumber) Makes API requests with the subdirectory /team/frc{teamNumber}/districts
java.lang.String[]	getEventKeys(int teamNumber) Makes API requests with the subdirectory /team/frc{teamNumber}/events/keys
java.lang.String[]	getEventKeys(int teamNumber, int year) Makes API requests with the subdirectory /team/frc{teamNumber}/events/{year}/keys
Event[]	getEvents(int teamNumber) Makes API requests with the subdirectory /team/frc{teamNumber}/events
Event[]	getEvents(int teamNumber, int year) Makes API requests with the subdirectory /team/frc{teamNumber}/events/{year}
TeamEventStatus	getEventStatus(int teamNumber, java.lang.String eventKey) Makes API requests with the subdirectory /team/frc{teamNumber}/event/{eventKey}/status
Match[]	getMatches(int teamNumber, int year) Makes API requests with the subdirectory /team/frc{teamNumber}/matches/{year}
Match[]	getMatches(int teamNumber, java.lang.String eventKey) Makes API requests with the subdirectory /team/frc{teamNumber}/event/{eventKey}/matches
java.lang.String[]	getMatchKeys(int teamNumber, int year) Makes API requests with the subdirectory /team/frc{teamNumber}/matches/{year}/keys
java.lang.String[]	getMatchKeys(int teamNumber, java.lang.String eventKey) Makes API requests with the subdirectory /team/frc{teamNumber}/event/{eventKey}/matches/keys
Media[]	getMedia(int teamNumber, int year) Makes API requests with the subdirectory /team/frc{teamNumber}/media/{year}
Robot[]	getRobots(int teamNumber) Makes API requests with the subdirectory /team/frc{teamNumber}/robots
SimpleEvent[]	getSimpleEvents(int teamNumber) Makes API requests with the subdirectory /team/frc{teamNumber}/events/simple
SimpleEvent[]	getSimpleEvents(int teamNumber, int year) Makes API requests with the subdirectory /team/frc{teamNumber}/events/{year}/simple
SimpleMatch[]	getSimpleMatches(int teamNumber, int year) Makes API requests with the subdirectory /team/frc{teamNumber}/matches/{year}/simple
SimpleMatch[]	getSimpleMatches(int teamNumber, java.lang.String eventKey) Makes API requests with the subdirectory /team/frc{teamNumber}/event/{eventKey}/matches/simple
SimpleTeam	getSimpleTeam(int teamNumber) Makes API requests with the subdirectory /team/frc{teamNumber}/simple
Media[]	getSocialMedia(int teamNumber) Makes API requests with the subdirectory /team/frc{teamNumber}/social_media
Team	getTeam(int teamNumber) Makes API requests with the subdirectory /team/frc{teamNumber}
int[]	getYearsParticipated(int teamNumber) Makes API requests with the subdirectory /team/frc{teamNumber}/years_participated

Methods inherited from class java.lang.Object

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

Constructor Detail

TeamRequest

public TeamRequest(DataRequest dataRequest)

Creates a TeamRequest object

Parameters:

dataRequest - A DataRequest object with the appropriate auth key

Method Detail

getTeam

public Team getTeam(int teamNumber)
             throws java.io.IOException

Makes API requests with the subdirectory /team/frc{teamNumber}

Parameters:

teamNumber - The FRC team number issued by FIRST

Returns:

The Team object referenced by the given team number

Throws:

java.io.IOException

getSimpleTeam

public SimpleTeam getSimpleTeam(int teamNumber)
                         throws java.io.IOException

Makes API requests with the subdirectory /team/frc{teamNumber}/simple

Parameters:

teamNumber - The FRC team number issued by FIRST

Returns:

The SimpleTeam object referenced by the given team number

Throws:

java.io.IOException

getYearsParticipated

public int[] getYearsParticipated(int teamNumber)
                           throws java.io.IOException

Makes API requests with the subdirectory /team/frc{teamNumber}/years_participated

Parameters:

teamNumber - The FRC team number issued by FIRST

Returns:

A list of years in which the team participated in at least one competition

Throws:

java.io.IOException

getDistricts

public District[] getDistricts(int teamNumber)
                        throws java.io.IOException

Makes API requests with the subdirectory /team/frc{teamNumber}/districts

Parameters:

teamNumber - The FRC team number issued by FIRST

Returns:

A list of Districts that the team was part of, for each year

Throws:

java.io.IOException

getRobots

public Robot[] getRobots(int teamNumber)
                  throws java.io.IOException

Makes API requests with the subdirectory /team/frc{teamNumber}/robots

Parameters:

teamNumber - The FRC team number issued by FIRST

Returns:

A list of Robots for each year that a robot name was provided. WIll be null if the team never named a robot.

Throws:

java.io.IOException

getEvents

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

Makes API requests with the subdirectory /team/frc{teamNumber}/events

Parameters:

teamNumber - The FRC team number issued by FIRST

Returns:

A list of all events the team competed at

Throws:

java.io.IOException

getEvents

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

Makes API requests with the subdirectory /team/frc{teamNumber}/events/{year}

Parameters:

teamNumber - The FRC team number issued by FIRST

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

Returns:

A list of all events the team competed at in the given year

Throws:

java.io.IOException

getSimpleEvents

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

Makes API requests with the subdirectory /team/frc{teamNumber}/events/simple

Parameters:

teamNumber - The FRC team number issued by FIRST

Returns:

A short-form list of all events the team competed at

Throws:

java.io.IOException

getSimpleEvents

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

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

Parameters:

teamNumber - The FRC team number issued by FIRST

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

Returns:

A short-form list of all events the team competed at in the given year

Throws:

java.io.IOException

getEventKeys

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

Makes API requests with the subdirectory /team/frc{teamNumber}/events/keys

Parameters:

teamNumber - The FRC team number issued by FIRST

Returns:

A list of all event keys for events that the team competed at

Throws:

java.io.IOException

getEventKeys

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

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

Parameters:

teamNumber - The FRC team number issued by FIRST

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

Returns:

A list of all event keys for events that the team competed at in the given year

Throws:

java.io.IOException

getMatches

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

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

Parameters:

teamNumber - The FRC team number issued by FIRST

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

Returns:

A list of all Matchs that the given team participated in the given event

Throws:

java.io.IOException

getSimpleMatches

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

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

Parameters:

teamNumber - The FRC team number issued by FIRST

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

Returns:

A list of all SimpleMatchs that the given team participated in the given event

Throws:

java.io.IOException

getMatchKeys

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

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

Parameters:

teamNumber - The FRC team number issued by FIRST

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

Returns:

A list of all match keys that the given team participated in the given event

Throws:

java.io.IOException

getAwards

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

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

Parameters:

teamNumber - The FRC team number issued by FIRST

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

Returns:

A list of all Awards won by the given team at the given event

Throws:

java.io.IOException

getEventStatus

public TeamEventStatus getEventStatus(int teamNumber,
                                      java.lang.String eventKey)
                               throws java.io.IOException

Makes API requests with the subdirectory /team/frc{teamNumber}/event/{eventKey}/status

Parameters:

teamNumber - The FRC team number issued by FIRST

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

Returns:

The competition rank and status of the team at the given event.

Throws:

java.io.IOException

getAwards

public Award[] getAwards(int teamNumber)
                  throws java.io.IOException

Makes API requests with the subdirectory /team/frc{teamNumber}/awards

Parameters:

teamNumber - The FRC team number issued by FIRST

Returns:

A list of all Awards that the given team has won

Throws:

java.io.IOException

getAwards

public Award[] getAwards(int teamNumber,
                         int year)
                  throws java.io.IOException

Makes API requests with the subdirectory /team/frc{teamNumber}/awards/{year}

Parameters:

teamNumber - The FRC team number issued by FIRST

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

Returns:

A list of all Awards that the given team won in the given year

Throws:

java.io.IOException

getMatches

public Match[] getMatches(int teamNumber,
                          int year)
                   throws java.io.IOException

Makes API requests with the subdirectory /team/frc{teamNumber}/matches/{year}

Parameters:

teamNumber - The FRC team number issued by FIRST

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

Returns:

A list of all Matchs that the given team participated in during the given year

Throws:

java.io.IOException

getSimpleMatches

public SimpleMatch[] getSimpleMatches(int teamNumber,
                                      int year)
                               throws java.io.IOException

Makes API requests with the subdirectory /team/frc{teamNumber}/matches/{year}/simple

Parameters:

teamNumber - The FRC team number issued by FIRST

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

Returns:

A list of all SimpleMatchs that the given team participated in during the given year

Throws:

java.io.IOException

getMatchKeys

public java.lang.String[] getMatchKeys(int teamNumber,
                                       int year)
                                throws java.io.IOException

Makes API requests with the subdirectory /team/frc{teamNumber}/matches/{year}/keys

Parameters:

teamNumber - The FRC team number issued by FIRST

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

Returns:

A list of all match keys for matches that the given team participated in during the given year

Throws:

java.io.IOException

getMedia

public Media[] getMedia(int teamNumber,
                        int year)
                 throws java.io.IOException

Makes API requests with the subdirectory /team/frc{teamNumber}/media/{year}

Parameters:

teamNumber - The FRC team number issued by FIRST

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

Returns:

A list of all Media for the given team and year

Throws:

java.io.IOException

getSocialMedia

public Media[] getSocialMedia(int teamNumber)
                       throws java.io.IOException

Makes API requests with the subdirectory /team/frc{teamNumber}/social_media

Parameters:

teamNumber - The FRC team number issued by FIRST

Returns:

A list of all (social) Media for the given team

Throws:

java.io.IOException