aboutsummaryrefslogtreecommitdiffstats
path: root/src/cgeo/geocaching/ICache.java
blob: 24dcd7c65ab628f906561c0a6bd1e42912f577ed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/**
 *
 */
package cgeo.geocaching;

import cgeo.geocaching.enumerations.CacheSize;

/**
 * Basic interface for caches
 *
 * @author blafoo
 *
 */
public interface ICache {

    /**
     * @return Geocode like GCxxxx
     */
    public String getGeocode();

    /**
     * @return Tradi, multi etc.
     */
    public String getType();

    /**
     * @return Displayed owner, might differ from the real owner
     */
    public String getOwner();

    /**
     * @return GC username of the owner
     */
    public String getOwnerReal();

    /**
     * @return Micro, small etc.
     */
    public CacheSize getSize();

    /**
     * @return Difficulty assessment
     */
    public Float getDifficulty();

    /**
     * @return Terrain assessment
     */
    public Float getTerrain();

    /**
     * @return Latitude, e.g. N 52° 12.345
     */
    public String getLatitude();

    /**
     * @return Longitude, e.g. E 9° 34.567
     */
    public String getLongitude();

    /**
     * @return true if the cache is disabled, false else
     */
    public boolean isDisabled();

    /**
     * @return true if the user is the owner of the cache, false else
     */
    public boolean isOwn();

    /**
     * @return true is the cache is archived, false else
     */
    public boolean isArchived();

    /**
     * @return true is the cache is a Premium Member cache only, false else
     */
    public boolean isMembersOnly();

    /**
     * @return Decrypted hint
     */
    public String getHint();

    /**
     * @return Description
     */
    public String getDescription();

    /**
     * @return Short Description
     */
    public String getShortDescription();

    /**
     * @return Name
     */
    public String getName();

}