com.thebluealliance.api.v3.models

Class Award

java.lang.Object

com.thebluealliance.api.v3.models.Award

public class Award
extends java.lang.Object

A Award object represents an award won at a FIRST Robotics Competition event and its associated descriptors.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Award.AwardRecipient An AwardRecipient object represents the team and/or person who received an award at an event.

Constructor Summary

Constructors

Constructor and Description
Award()

Method Summary

Modifier and Type	Method and Description
int	getAwardType()
java.lang.String	getEventKey()
java.lang.String	getName()
Award.AwardRecipient[]	getRecipientList()
int	getYear()

Methods inherited from class java.lang.Object

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

Constructor Detail

Award

public Award()

Method Detail

getName

public java.lang.String getName()

Returns:

The name of the award as provided by FIRST. May vary for the same award type.

getEventKey

public java.lang.String getEventKey()

Returns:

The event_key of the event the award was won at.

getAwardType

public int getAwardType()

Returns:

Integer representing the type of award given.

See Also:

award_type.py

getYear

public int getYear()

Returns:

The year this award was won.

getRecipientList

public Award.AwardRecipient[] getRecipientList()

Returns:

A list of recipients of the award at the event.