fi.foyt.foursquare.api.entities

Class CompleteSpecial

java.lang.Object

fi.foyt.foursquare.api.entities.CompleteSpecial

All Implemented Interfaces:

FoursquareEntity, Serializable

public class CompleteSpecial
extends Object
implements FoursquareEntity

Class representing CompleteSpecial entity

Author:

Antti Leppä

See Also:

https://developer.foursquare.com/docs/responses/special.html, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CompleteSpecial()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns a description of how to unlock the special.
String	getFinePrint() Returns specific rules for this special.
String	getIcon() Returns the name of the icon to use: http://foursquare.com/img/specials/icon.png
String	getId() Returns id of this venue
String	getMessage() Returns a message describing the special.
String	getProvider() Returns provider
String	getRedemption() Returns redemption
String	getState() Returns state.
String	getTitle() Returns a title of the special
String	getType() Returns type of the venue.
Boolean	getUnlocked() Returns true or false indicating if this special is unlocked for the acting user.
CompactVenue	getVenue() Returns venue

Methods inherited from class java.lang.Object

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

Constructor Detail

CompleteSpecial

public CompleteSpecial()

Method Detail

getId

public String getId()

Returns id of this venue

Returns:

id of this venue

getType

public String getType()

Returns type of the venue. One of mayor, count, frequency, regular, friends, swarm, flash or other.

Returns:

type of the venue

getMessage

public String getMessage()

Returns a message describing the special.

Returns:

a message describing the special

getFinePrint

public String getFinePrint()

Returns specific rules for this special.

Returns:

specific rules for this special.

getDescription

public String getDescription()

Returns a description of how to unlock the special.

Returns:

description of how to unlock the special.

getUnlocked

public Boolean getUnlocked()

Returns true or false indicating if this special is unlocked for the acting user.

Returns:

true or false indicating if this special is unlocked for the acting user.

getIcon

public String getIcon()

Returns the name of the icon to use: http://foursquare.com/img/specials/icon.png

Returns:

the name of the icon

getTitle

public String getTitle()

Returns a title of the special

Returns:

a title of the special

getState

public String getState()

Returns state. One of unlocked, before start, in progress, taken, locked

Returns:

state

getProvider

public String getProvider()

Returns provider

Returns:

provider

getRedemption

public String getRedemption()

Returns redemption

Returns:

redemption

getVenue

public CompactVenue getVenue()

Returns venue

Returns:

venue