KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > tonbeller > wcf > bookmarks > Bookmarkable


1 /*
2  * ====================================================================
3  * This software is subject to the terms of the Common Public License
4  * Agreement, available at the following URL:
5  * http://www.opensource.org/licenses/cpl.html .
6  * Copyright (C) 2003-2004 TONBELLER AG.
7  * All Rights Reserved.
8  * You must accept the terms of that agreement to use this software.
9  * ====================================================================
10  *
11  *
12  */
13 package com.tonbeller.wcf.bookmarks;
14
15 /**
16  * State may be saved and restored later
17  * @author av
18  */
19 public interface Bookmarkable {
20   
21   /**
22    * The bookmark should contain as much detail as possible, even if it may not work
23    * after the schema has changed.
24    * See <a HREF="http://www.esgs.org/uk/inex.htm">http://www.esgs.org/uk/inex.htm</a>
25    */
26   public static final int EXTENSIONAL = 0;
27   
28   /**
29    * The bookmark should contain a generic description which may contain less details
30    * but works in all conditions.
31    * See <a HREF="http://www.esgs.org/uk/inex.htm">http://www.esgs.org/uk/inex.htm</a>
32    */
33   public static final int INTENSIONAL = 1;
34
35   /**
36    * retrieves the state of this instance
37    * @param levelOfDetail INTENSIONAL or EXTENSIONAL
38    */
39   Object JavaDoc getBookmarkState(int levelOfDetail);
40
41   /**
42    * sets the state of this instance
43    * @param state the state returned by getBookmarkState
44    */
45   void setBookmarkState(Object JavaDoc state);
46 }
47
Popular Tags