All Implemented Interfaces:
```
public final class GeocachingData
extends Storable
                    
```
Container for main Geocaching data
INFO
all times are in format '2009-09-22T14:16:03.0000000+0200', where important is only first part (Date), so it should looks for example only as '2009-09-22T'. This should work
Groundspeak staging API: https://staging.api.groundspeak.com/Live/v6beta/geocaching.svc/help

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`GeocachingData.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private Long`	`id`
`private String`	`cacheID`
`private Boolean`	`isAvailable`
`private Boolean`	`isArchived`
`private Boolean`	`isPremiumOnly`
`private String`	`name`
`private String`	`placedBy`
`private String`	`owner`
`private Long`	`dateHidden`
`private Long`	`datePublished`
`private Long`	`dateUpdated`
`private Integer`	`type`
`private Integer`	`container`
`private Float`	`difficulty`
`private Float`	`terrain`
`private String`	`country`
`private String`	`state`
`private String`	`encodedHints`
`private List<GeocachingAttribute>`	`attributes`
`private List<GeocachingLog>`	`logs`
`private List<GeocachingTrackable>`	`trackables`
`private List<GeocachingWaypoint>`	`waypoints`
`private String`	`notes`
`private Boolean`	`isComputed`
`private Boolean`	`isFound`
`private String`	`cacheUrl`
`private Integer`	`favoritePoints`
`private Integer`	`gcVoteNumOfVotes`
`private Float`	`gcVoteAverage`
`private Float`	`gcVoteUserVote`
`private Double`	`lonOriginal`
`private Double`	`latOriginal`
`private List<GeocachingImage>`	`images`
`private Integer`	`source`
`private final String`	`containerText`
`private final Array<String>`	`descriptions`
`private final String`	`cacheUrlFull`
`private final Boolean`	`isCacheValid`
`private final Storable`	`copy`
`private final ByteArray`	`asBytes`

Constructor Summary

Constructors
Constructor	Description
`GeocachingData()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Long`	`getId()`	Current defined ID of cache.
`final Unit`	`setId(Long id)`	Current defined ID of cache.
`final String`	`getCacheID()`	Whole cache ID from gc.com - so GC...
`final Unit`	`setCacheID(String cacheID)`
`final Boolean`	`getIsAvailable()`	State of cache - available or disable.
`final Unit`	`setIsAvailable(Boolean isAvailable)`	State of cache - available or disable.
`final Boolean`	`getIsArchived()`	State of cache - already archived or not.
`final Unit`	`setIsArchived(Boolean isArchived)`	State of cache - already archived or not.
`final Boolean`	`getIsPremiumOnly()`	Flag if cache is only for a premium members.
`final Unit`	`setIsPremiumOnly(Boolean isPremiumOnly)`	Flag if cache is only for a premium members.
`final String`	`getName()`	Name of cache visible on all places in Locus as an title.
`final Unit`	`setName(String name)`	Name of cache visible on all places in Locus as an title.
`final String`	`getPlacedBy()`	Name of person who placed cache (groundspeak:placed_by).
`final Unit`	`setPlacedBy(String placedBy)`	Name of person who placed cache (groundspeak:placed_by).
`final String`	`getOwner()`	Name of cache owner (groundspeak:owner).
`final Unit`	`setOwner(String owner)`	Name of cache owner (groundspeak:owner).
`final Long`	`getDateHidden()`	Get date/time, when owner create/hide cache on a gc.com web page.
`final Unit`	`setDateHidden(Long dateHidden)`	Get date/time, when owner create/hide cache on a gc.com web page.
`final Long`	`getDatePublished()`	Date/time, when owner published cache for users.
`final Unit`	`setDatePublished(Long datePublished)`	Date/time, when owner published cache for users.
`final Long`	`getDateUpdated()`	Date/time, when cache was updated for the last time, on gc.com server.
`final Unit`	`setDateUpdated(Long dateUpdated)`	Date/time, when cache was updated for the last time, on gc.com server.
`final Integer`	`getType()`	Type of a cache, define by constants CACHE_TYPE_X.
`final Unit`	`setType(Integer type)`	Type of a cache, define by constants CACHE_TYPE_X.
`final Integer`	`getContainer()`	Size of cache container.
`final Unit`	`setContainer(Integer container)`	Size of cache container.
`final Float`	`getDifficulty()`	Difficulty value - 1.0 - 5.0 (by 0.5).
`final Unit`	`setDifficulty(Float difficulty)`	Difficulty value - 1.0 - 5.0 (by 0.5).
`final Float`	`getTerrain()`	Terrain value - 1.0 - 5.0 (by 0.5).
`final Unit`	`setTerrain(Float terrain)`	Terrain value - 1.0 - 5.0 (by 0.5).
`final String`	`getCountry()`	Name of country, where is cache places.
`final Unit`	`setCountry(String country)`	Name of country, where is cache places.
`final String`	`getState()`	Name of state, where is cache places.
`final Unit`	`setState(String state)`	Name of state, where is cache places.
`final String`	`getEncodedHints()`	Encoded hints.
`final Unit`	`setEncodedHints(String encodedHints)`	Encoded hints.
`final List<GeocachingAttribute>`	`getAttributes()`	List of attributes.
`final Unit`	`setAttributes(List<GeocachingAttribute> attributes)`	List of attributes.
`final List<GeocachingLog>`	`getLogs()`	List of logs.
`final Unit`	`setLogs(List<GeocachingLog> logs)`	List of logs.
`final List<GeocachingTrackable>`	`getTrackables()`	List of travel bugs.
`final Unit`	`setTrackables(List<GeocachingTrackable> trackables)`	List of travel bugs.
`final List<GeocachingWaypoint>`	`getWaypoints()`	List of waypoints.
`final Unit`	`setWaypoints(List<GeocachingWaypoint> waypoints)`	List of waypoints.
`final String`	`getNotes()`	User notes.
`final Unit`	`setNotes(String notes)`	User notes.
`final Boolean`	`getIsComputed()`	Flag if cache is 'computed' - have corrected coordinates.
`final Unit`	`setIsComputed(Boolean isComputed)`	Flag if cache is 'computed' - have corrected coordinates.
`final Boolean`	`getIsFound()`	Flag if cache is already found by user.
`final Unit`	`setIsFound(Boolean isFound)`	Flag if cache is already found by user.
`final String`	`getCacheUrl()`	Stored URL to cache itself.
`final Unit`	`setCacheUrl(String cacheUrl)`	Stored URL to cache itself.
`final Integer`	`getFavoritePoints()`	Number of favorite points attached to current cache.
`final Unit`	`setFavoritePoints(Integer favoritePoints)`	Number of favorite points attached to current cache.
`final Integer`	`getGcVoteNumOfVotes()`	GcVote - number of votes.
`final Unit`	`setGcVoteNumOfVotes(Integer gcVoteNumOfVotes)`	GcVote - number of votes.
`final Float`	`getGcVoteAverage()`	Average (not median) value.
`final Unit`	`setGcVoteAverage(Float gcVoteAverage)`	Average (not median) value.
`final Float`	`getGcVoteUserVote()`	User value for GCVote.
`final Unit`	`setGcVoteUserVote(Float gcVoteUserVote)`	User value for GCVote.
`final Double`	`getLonOriginal()`	Original longitude defined by owner.
`final Unit`	`setLonOriginal(Double lonOriginal)`	Original longitude defined by owner.
`final Double`	`getLatOriginal()`	Original latitude defined by owner.
`final Unit`	`setLatOriginal(Double latOriginal)`	Original latitude defined by owner.
`final List<GeocachingImage>`	`getImages()`	List of attached images.
`final Unit`	`setImages(List<GeocachingImage> images)`	List of attached images.
`final Integer`	`getSource()`	Define source of this cache as constant value.
`final Unit`	`setSource(Integer source)`	Define source of this cache as constant value.
`final String`	`getContainerText()`
`final Array<String>`	`getDescriptions()`
`final String`	`getCacheUrlFull()`
`final Boolean`	`getIsCacheValid()`
`final Storable`	`getCopy()`
`final ByteArray`	`getAsBytes()`
`final Unit`	`setContainer(String value)`
`final Boolean`	`setDescriptions(String shortDesc, Boolean shortInHtml, String longDesc, Boolean longInHtml)`
`final Unit`	`setType(String type)`	Set type of the cache from the String representation.
`final Boolean`	`containsInData(String text)`	Check if owner, country, state or description contains certain defined text.

Methods inherited from class locus.api.objects.geocaching.GeocachingData
read, read, read, write
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GeocachingData
```
GeocachingData()
```
- Method Detail
  - getId
```
 final Long getId()
```
    Current defined ID of cache. This ID is just optional unique identification as long number that has no extra usage in Locus.
  - setId
```
 final Unit setId(Long id)
```
    Current defined ID of cache. This ID is just optional unique identification as long number that has no extra usage in Locus.
  - getCacheID
```
 final String getCacheID()
```
    Whole cache ID from gc.com - so GC... REQUIRED
  - setCacheID
```
 final Unit setCacheID(String cacheID)
```
  - getIsAvailable
```
 final Boolean getIsAvailable()
```
    State of cache - available or disable.
  - setIsAvailable
```
 final Unit setIsAvailable(Boolean isAvailable)
```
    State of cache - available or disable.
  - getIsArchived
```
 final Boolean getIsArchived()
```
    State of cache - already archived or not.
  - setIsArchived
```
 final Unit setIsArchived(Boolean isArchived)
```
    State of cache - already archived or not.
  - getIsPremiumOnly
```
 final Boolean getIsPremiumOnly()
```
    Flag if cache is only for a premium members.
  - setIsPremiumOnly
```
 final Unit setIsPremiumOnly(Boolean isPremiumOnly)
```
    Flag if cache is only for a premium members.
  - getName
```
 final String getName()
```
    Name of cache visible on all places in Locus as an title. REQUIRED!
  - setName
```
 final Unit setName(String name)
```
    Name of cache visible on all places in Locus as an title. REQUIRED!
  - getPlacedBy
```
 final String getPlacedBy()
```
    Name of person who placed cache (groundspeak:placed_by). It is displayed in Locus when tapped on point or in main GC page.
  - setPlacedBy
```
 final Unit setPlacedBy(String placedBy)
```
    Name of person who placed cache (groundspeak:placed_by). It is displayed in Locus when tapped on point or in main GC page.
  - getOwner
```
 final String getOwner()
```
    Name of cache owner (groundspeak:owner). This value is not displayed in Locus.
  - setOwner
```
 final Unit setOwner(String owner)
```
    Name of cache owner (groundspeak:owner). This value is not displayed in Locus.
  - getDateHidden
```
 final Long getDateHidden()
```
    Get date/time, when owner create/hide cache on a gc.com web page.
  - setDateHidden
```
 final Unit setDateHidden(Long dateHidden)
```
    Get date/time, when owner create/hide cache on a gc.com web page.
  - getDatePublished
```
 final Long getDatePublished()
```
    Date/time, when owner published cache for users. Usually most important date.
  - setDatePublished
```
 final Unit setDatePublished(Long datePublished)
```
    Date/time, when owner published cache for users. Usually most important date.
  - getDateUpdated
```
 final Long getDateUpdated()
```
    Date/time, when cache was updated for the last time, on gc.com server.
  - setDateUpdated
```
 final Unit setDateUpdated(Long dateUpdated)
```
    Date/time, when cache was updated for the last time, on gc.com server.
  - getType
```
 final Integer getType()
```
    Type of a cache, define by constants CACHE_TYPE_X.
  - setType
```
 final Unit setType(Integer type)
```
    Type of a cache, define by constants CACHE_TYPE_X.
  - getContainer
```
 final Integer getContainer()
```
    Size of cache container. Size is defined by parameters CACHE_SIZE_X, or by text directly.
  - setContainer
```
 final Unit setContainer(Integer container)
```
    Size of cache container. Size is defined by parameters CACHE_SIZE_X, or by text directly.
  - getDifficulty
```
 final Float getDifficulty()
```
    Difficulty value - 1.0 - 5.0 (by 0.5).
  - setDifficulty
```
 final Unit setDifficulty(Float difficulty)
```
    Difficulty value - 1.0 - 5.0 (by 0.5).
  - getTerrain
```
 final Float getTerrain()
```
    Terrain value - 1.0 - 5.0 (by 0.5).
  - setTerrain
```
 final Unit setTerrain(Float terrain)
```
    Terrain value - 1.0 - 5.0 (by 0.5).
  - getCountry
```
 final String getCountry()
```
    Name of country, where is cache places.
  - setCountry
```
 final Unit setCountry(String country)
```
    Name of country, where is cache places.
  - getState
```
 final String getState()
```
    Name of state, where is cache places.
  - setState
```
 final Unit setState(String state)
```
    Name of state, where is cache places.
  - getEncodedHints
```
 final String getEncodedHints()
```
    Encoded hints.
  - setEncodedHints
```
 final Unit setEncodedHints(String encodedHints)
```
    Encoded hints.
  - getAttributes
```
 final List<GeocachingAttribute> getAttributes()
```
    List of attributes.
  - setAttributes
```
 final Unit setAttributes(List<GeocachingAttribute> attributes)
```
    List of attributes.
  - getLogs
```
 final List<GeocachingLog> getLogs()
```
    List of logs.
  - setLogs
```
 final Unit setLogs(List<GeocachingLog> logs)
```
    List of logs.
  - getTrackables
```
 final List<GeocachingTrackable> getTrackables()
```
    List of travel bugs.
  - setTrackables
```
 final Unit setTrackables(List<GeocachingTrackable> trackables)
```
    List of travel bugs.
  - getWaypoints
```
 final List<GeocachingWaypoint> getWaypoints()
```
    List of waypoints.
  - setWaypoints
```
 final Unit setWaypoints(List<GeocachingWaypoint> waypoints)
```
    List of waypoints.
  - getNotes
```
 final String getNotes()
```
    User notes.
  - setNotes
```
 final Unit setNotes(String notes)
```
    User notes.
  - getIsComputed
```
 final Boolean getIsComputed()
```
    Flag if cache is 'computed' - have corrected coordinates.
  - setIsComputed
```
 final Unit setIsComputed(Boolean isComputed)
```
    Flag if cache is 'computed' - have corrected coordinates.
  - getIsFound
```
 final Boolean getIsFound()
```
    Flag if cache is already found by user.
  - setIsFound
```
 final Unit setIsFound(Boolean isFound)
```
    Flag if cache is already found by user.
  - getCacheUrl
```
 final String getCacheUrl()
```
    Stored URL to cache itself. Keep in mind that this value may not be defined or may include various formats. Suggested is to use .getCacheUrlFull method, that should return valid URL.
  - setCacheUrl
```
 final Unit setCacheUrl(String cacheUrl)
```
    Stored URL to cache itself. Keep in mind that this value may not be defined or may include various formats. Suggested is to use .getCacheUrlFull method, that should return valid URL.
  - getFavoritePoints
```
 final Integer getFavoritePoints()
```
    Number of favorite points attached to current cache.
  - setFavoritePoints
```
 final Unit setFavoritePoints(Integer favoritePoints)
```
    Number of favorite points attached to current cache.
  - getGcVoteNumOfVotes
```
 final Integer getGcVoteNumOfVotes()
```
    GcVote - number of votes.
  - setGcVoteNumOfVotes
```
 final Unit setGcVoteNumOfVotes(Integer gcVoteNumOfVotes)
```
    GcVote - number of votes.
  - getGcVoteAverage
```
 final Float getGcVoteAverage()
```
    Average (not median) value.
  - setGcVoteAverage
```
 final Unit setGcVoteAverage(Float gcVoteAverage)
```
    Average (not median) value.
  - getGcVoteUserVote
```
 final Float getGcVoteUserVote()
```
    User value for GCVote.
  - setGcVoteUserVote
```
 final Unit setGcVoteUserVote(Float gcVoteUserVote)
```
    User value for GCVote.
  - getLonOriginal
```
 final Double getLonOriginal()
```
    Original longitude defined by owner.
  - setLonOriginal
```
 final Unit setLonOriginal(Double lonOriginal)
```
    Original longitude defined by owner.
  - getLatOriginal
```
 final Double getLatOriginal()
```
    Original latitude defined by owner.
  - setLatOriginal
```
 final Unit setLatOriginal(Double latOriginal)
```
    Original latitude defined by owner.
  - getImages
```
 final List<GeocachingImage> getImages()
```
    List of attached images.
  - setImages
```
 final Unit setImages(List<GeocachingImage> images)
```
    List of attached images.
  - getSource
```
 final Integer getSource()
```
    Define source of this cache as constant value. Be aware, that this value is automatically set when setup a cacheID, so use this method after the .setCacheID function is used.
  - setSource
```
 final Unit setSource(Integer source)
```
    Define source of this cache as constant value. Be aware, that this value is automatically set when setup a cacheID, so use this method after the .setCacheID function is used.
  - getContainerText
```
 final String getContainerText()
```
  - getDescriptions
```
 final Array<String> getDescriptions()
```
  - getCacheUrlFull
```
 final String getCacheUrlFull()
```
  - getIsCacheValid
```
 final Boolean getIsCacheValid()
```
  - getCopy
```
 final Storable getCopy()
```
  - getAsBytes
```
 final ByteArray getAsBytes()
```
  - setContainer
```
 final Unit setContainer(String value)
```
  - setDescriptions
```
 final Boolean setDescriptions(String shortDesc, Boolean shortInHtml, String longDesc, Boolean longInHtml)
```
  - setType
```
 final Unit setType(String type)
```
    Set type of the cache from the String representation.
  - containsInData
```
 final Boolean containsInData(String text)
```
    Check if owner, country, state or description contains certain defined text.
    
    Parameters:
    
    text - text that we search

Class GeocachingData

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class locus.api.objects.geocaching.GeocachingData

Methods inherited from class java.lang.Object

Constructor Detail

GeocachingData

Method Detail

getId

setId

getCacheID

setCacheID

getIsAvailable

setIsAvailable

getIsArchived

setIsArchived

getIsPremiumOnly

setIsPremiumOnly

getName

setName

getPlacedBy

setPlacedBy

getOwner

setOwner

getDateHidden

setDateHidden

getDatePublished

setDatePublished

getDateUpdated

setDateUpdated

getType

setType

getContainer

setContainer

getDifficulty

setDifficulty

getTerrain

setTerrain

getCountry

setCountry

getState

setState

getEncodedHints

setEncodedHints

getAttributes

setAttributes

getLogs

setLogs

getTrackables

setTrackables

getWaypoints

setWaypoints

getNotes

setNotes

getIsComputed

setIsComputed

getIsFound

setIsFound

getCacheUrl

setCacheUrl

getFavoritePoints

setFavoritePoints

getGcVoteNumOfVotes

setGcVoteNumOfVotes

getGcVoteAverage

setGcVoteAverage

getGcVoteUserVote

setGcVoteUserVote

getLonOriginal

setLonOriginal

getLatOriginal

setLatOriginal

getImages

setImages

getSource

setSource

getContainerText