View Javadoc

1   // %1126721330901:hoplugins.transfers.vo%
2   package hoplugins.transfers.vo;
3   
4   /***
5    * Value Object representing a bookmark.
6    *
7    * @author <a href=mailto:nethyperon@users.sourceforge.net>Boy van der Werf</a>
8    */
9   public class Bookmark {
10      //~ Static fields/initializers -----------------------------------------------------------------
11  
12      /*** Team bookmark */
13      public static final int TEAM = 0;
14  
15      /*** Player bookmark */
16      public static final int PLAYER = 1;
17  
18      //~ Instance fields ----------------------------------------------------------------------------
19  
20      /*** Bookmark name */
21      private String name;
22  
23      /*** Bookmark id */
24      private int id;
25  
26      /*** Bookmark type */
27      private int type;
28  
29      //~ Constructors -------------------------------------------------------------------------------
30  
31      /***
32       * Creates an instance of Bookmark representing a
33       * bookmark of an item.
34       * 
35       * @param type Type of the bookmark
36       * @param id Id of the bookmarked item
37       * @param name name of the bookmark
38       */
39      public Bookmark(int type, int id, String name) {
40          this.type = type;
41          this.id = id;
42          this.name = name;
43      }
44  
45      //~ Methods ------------------------------------------------------------------------------------
46  
47      /***
48       * Gets the id of the bookmark.
49       *
50       * @return Id of the bookmark
51       */
52      public final int getId() {
53          return id;
54      }
55  
56      /***
57       * Gets the name of the bookmark.
58       *
59       * @return Name of the bookmark
60       */
61      public final String getName() {
62          return name;
63      }
64  
65      /***
66       * Gets the type of the bookmark.
67       *
68       * @return Type of the bookmark
69       */
70      public final int getType() {
71          return type;
72      }
73  }