geocaching.api
Class GeocachingApi

java.lang.Object
  geocaching.api.GeocachingApi

Direct Known Subclasses:

LiveGeocachingApi

public abstract class GeocachingApi
extends Object

Field Summary

protected String

session

Constructor Summary

GeocachingApi()

Method Summary

abstract void	closeSession()
CacheLog	createFieldNoteAndPublish(FieldNote fieldNote, boolean publish, ImageData imageData, boolean favoriteThisCache)
abstract CacheLog	createFieldNoteAndPublish(String cacheCode, LogType logType, Date dateLogged, String note, boolean publish, ImageData imageData, boolean favoriteThisCache)
Geocache	getCache(String cacheCode)
abstract List<CacheLog>	getCacheLogs(String cacheCode, int startPosition, int endPosition)
List<SimpleGeocache>	getCaches(String[] cacheCodes, boolean isLite, int startIndex, int maxPerPage, int geocacheLogCount, int trackableLogCount)
List<SimpleGeocache>	getCachesByCoordinates(double latitude, double longitude, int startPosition, int endPosition, float radiusMiles)
List<SimpleGeocache>	getCachesByCoordinates(double latitude, double longitude, int startPosition, int endPosition, float radiusMiles, CacheType[] cacheTypes) Deprecated.
SimpleGeocache	getCacheSimple(String cacheCode)
String	getSession()
abstract TravelBug	getTravelBug(String travelBugCode)
abstract List<TravelBug>	getTravelBugsByCache(String cacheCode)
abstract UserProfile	getYourUserProfile(boolean favoritePointData, boolean geocacheData, boolean publicProfileData, boolean souvenirData, boolean trackableData)
abstract boolean	isSessionValid()
void	openSession(String session)
abstract void	openSession(String userName, String password)
abstract List<SimpleGeocache>	searchForGeocaches(boolean isLite, int startIndex, int maxPerPage, int geocacheLogCount, int trackableLogCount, Filter[] filters)

Methods inherited from class java.lang.Object

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

Field Detail

session

protected String session

Constructor Detail

GeocachingApi

public GeocachingApi()

Method Detail

getSession

public String getSession()

openSession

public void openSession(String session)
                 throws GeocachingApiException

Throws:

GeocachingApiException

openSession

public abstract void openSession(String userName,
                                 String password)
                          throws GeocachingApiException

Throws:

GeocachingApiException

closeSession

public abstract void closeSession()

isSessionValid

public abstract boolean isSessionValid()

getCachesByCoordinates

public List<SimpleGeocache> getCachesByCoordinates(double latitude,
                                                   double longitude,
                                                   int startPosition,
                                                   int endPosition,
                                                   float radiusMiles)
                                            throws GeocachingApiException

Throws:

GeocachingApiException

getTravelBug

public abstract TravelBug getTravelBug(String travelBugCode)
                                throws GeocachingApiException

Throws:

GeocachingApiException

getTravelBugsByCache

public abstract List<TravelBug> getTravelBugsByCache(String cacheCode)
                                              throws GeocachingApiException

Throws:

GeocachingApiException

getCacheLogs

public abstract List<CacheLog> getCacheLogs(String cacheCode,
                                            int startPosition,
                                            int endPosition)
                                     throws GeocachingApiException

Throws:

GeocachingApiException

getCachesByCoordinates

@Deprecated
public List<SimpleGeocache> getCachesByCoordinates(double latitude,
                                                              double longitude,
                                                              int startPosition,
                                                              int endPosition,
                                                              float radiusMiles,
                                                              CacheType[] cacheTypes)
                                            throws GeocachingApiException

Deprecated.

Throws:

GeocachingApiException

getCacheSimple

public SimpleGeocache getCacheSimple(String cacheCode)
                              throws GeocachingApiException

Throws:

GeocachingApiException

getCache

public Geocache getCache(String cacheCode)
                  throws GeocachingApiException

Throws:

GeocachingApiException

getCaches

public List<SimpleGeocache> getCaches(String[] cacheCodes,
                                      boolean isLite,
                                      int startIndex,
                                      int maxPerPage,
                                      int geocacheLogCount,
                                      int trackableLogCount)
                               throws GeocachingApiException

Throws:

GeocachingApiException

searchForGeocaches

public abstract List<SimpleGeocache> searchForGeocaches(boolean isLite,
                                                        int startIndex,
                                                        int maxPerPage,
                                                        int geocacheLogCount,
                                                        int trackableLogCount,
                                                        Filter[] filters)
                                                 throws GeocachingApiException

Throws:

GeocachingApiException

getYourUserProfile

public abstract UserProfile getYourUserProfile(boolean favoritePointData,
                                               boolean geocacheData,
                                               boolean publicProfileData,
                                               boolean souvenirData,
                                               boolean trackableData)
                                        throws GeocachingApiException

Throws:

GeocachingApiException

createFieldNoteAndPublish

public abstract CacheLog createFieldNoteAndPublish(String cacheCode,
                                                   LogType logType,
                                                   Date dateLogged,
                                                   String note,
                                                   boolean publish,
                                                   ImageData imageData,
                                                   boolean favoriteThisCache)
                                            throws GeocachingApiException

Throws:

GeocachingApiException

createFieldNoteAndPublish

public CacheLog createFieldNoteAndPublish(FieldNote fieldNote,
                                          boolean publish,
                                          ImageData imageData,
                                          boolean favoriteThisCache)
                                   throws GeocachingApiException

Throws:

GeocachingApiException