com.thebluealliance.api.v3.models

Class SimpleEvent

java.lang.Object

com.thebluealliance.api.v3.models.SimpleEvent

public class SimpleEvent
extends java.lang.Object

Shortform representation of a FIRST Robotics Competition event

Constructor Summary

Constructors

Constructor and Description
SimpleEvent()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCity()
java.lang.String	getCountry()
District	getDistrict()
java.lang.String	getEndDate()
java.lang.String	getEventCode()
int	getEventType()
java.lang.String	getKey()
java.lang.String	getName()
java.lang.String	getStartDate()
java.lang.String	getStateProv()
int	getYear()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleEvent

public SimpleEvent()

Method Detail

getEventType

public int getEventType()

Returns:

Event Type, as defined here

getYear

public int getYear()

Returns:

Year the event data is for.

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.