com.thebluealliance.api.v3.models

Class Event

java.lang.Object

com.thebluealliance.api.v3.models.Event

public class Event
extends java.lang.Object

Represents a FIRST Robotics Competition event and its related descriptors

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Event.Webcast Represents a webcast and its associated descriptors

Constructor Summary

Constructors

Constructor and Description
Event()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAddress()
java.lang.String	getCity()
java.lang.String	getCountry()
District	getDistrict()
java.lang.String[]	getDivisionKeys()
java.lang.String	getEndDate()
java.lang.String	getEventCode()
int	getEventType()
java.lang.String	getEventTypeString()
java.lang.String	getFirstEventId()
java.lang.String	getGmapsPlaceId()
java.lang.String	getGmapsUrl()
java.lang.String	getKey()
double	getLat()
double	getLng()
java.lang.String	getLocationName()
java.lang.String	getName()
java.lang.String	getParentEventKey()
int	getPlayoffType()
java.lang.String	getPlayoffTypeString()
java.lang.String	getPostalCode()
java.lang.String	getShortName()
java.lang.String	getStartDate()
java.lang.String	getStateProv()
java.lang.String	getTimezone()
Event.Webcast[]	getWebcasts()
java.lang.String	getWebsite()
int	getWeek()
int	getYear()

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event()

Method Detail

getWebcasts

public Event.Webcast[] getWebcasts()

Returns:

A list of webcasts for the event

getPostalCode

public java.lang.String getPostalCode()

Returns:

Postal code from the event address.

getParentEventKey

public java.lang.String getParentEventKey()

Returns:

The TBA Event key that represents the event�s parent. Used to link back to the event from a division event. It is also the inverse relation of divison_keys.

getShortName

public java.lang.String getShortName()

Returns:

Same as name but doesn�t include event specifiers, such as �Regional� or 'District�. May be null.

getGmapsUrl

public java.lang.String getGmapsUrl()

Returns:

Link to address location on Google Maps.

getPlayoffTypeString

public java.lang.String getPlayoffTypeString()

Returns:

String representation of the playoff_type, or null.

getEventTypeString

public java.lang.String getEventTypeString()

Returns:

Event Type, eg Regional, District, or Offseason.

getGmapsPlaceId

public java.lang.String getGmapsPlaceId()

Returns:

Google Maps Place ID for the event address.

getAddress

public java.lang.String getAddress()

Returns:

Address of the event�s venue, if available

getLocationName

public java.lang.String getLocationName()

Returns:

Name of the location at the address for the event, eg. Blue Alliance High School.

getTimezone

public java.lang.String getTimezone()

Returns:

Timezone name.

getWebsite

public java.lang.String getWebsite()

Returns:

The event�s website, if any.

getLat

public double getLat()

Returns:

Latitude for the event address.

getLng

public double getLng()

Returns:

Longitude for the event address.

getDivisionKeys

public java.lang.String[] getDivisionKeys()

Returns:

An array of event keys for the divisions at this event.

getFirstEventId

public java.lang.String getFirstEventId()

Returns:

The FIRST internal Event ID, used to link to the event on the FRC webpage.

getWeek

public int getWeek()

Returns:

Week of the competition season this event is in.

getYear

public int getYear()

Returns:

Year the event data is for.

getPlayoffType

public int getPlayoffType()

Returns:

Playoff Type, as defined here , or null.

getEventType

public int getEventType()

Returns:

Event Type, as defined here

getCity

public java.lang.String getCity()

Returns:

City, town, village, etc. the event is located in.

getStartDate

public java.lang.String getStartDate()

Returns:

Event start date in yyyy-mm-dd format.

getName

public java.lang.String getName()

Returns:

Official name of event on record either provided by FIRST or organizers of offseason event.

getEventCode

public java.lang.String getEventCode()

Returns:

Event short code, as provided by FIRST.

getEndDate

public java.lang.String getEndDate()

Returns:

Event end date in yyyy-mm-dd format.

getCountry

public java.lang.String getCountry()

Returns:

Country the event is located in.

getStateProv

public java.lang.String getStateProv()

Returns:

State or Province the event is located in.

getKey

public java.lang.String getKey()

Returns:

TBA event key with the format yyyy[EVENT_CODE], where yyyy is the year, and EVENT_CODE is the event code of the event.

getDistrict

public District getDistrict()

Returns:

A District object representing the district the event is in. May be null.