Package com.levigo.jadice.web.shared.model.bookmark

Class SerializableBookmarkList

java.lang.Object

com.levigo.jadice.web.shared.model.bookmark.SerializableBookmarkList

public class SerializableBookmarkList
extends Object

A serializable representation of a BookmarkList intended to be used on the server side. Serves as a container for SerializableBookmarks.

When invoking the operation to send the bookmarks from the client to the server, all bookmarks are contained in a SerializableBookmarkList. The SerializableBookmarkList can be retrieved from the corresponding document as a document property with a key of "SerializableBookmarkList". Use it in your server operation implementation to e.g. persist bookmarks in a third party system.

Use it in your DocumentDataProvider to attach persisted bookmarks while loading a document. The bookmarks will be added automatically on the client side.

For further details and code examples take a look at https://webtoolkit.jadice.com/showcase.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_KEY_SERIALIZABLE_BOOKMARK_LIST

Constructor Summary

Constructors

Constructor	Description
SerializableBookmarkList()	Constructs a new empty list.

Method Summary

Modifier and Type	Method	Description
void	add(SerializableBookmark serializableBookmark)	Adds the given SerializableBookmark to the list
List<SerializableBookmark>	getAll()	Returns a list containing all the bookmarks in the list.
void	remove(SerializableBookmark serializableBookmark)	Removes the given bookmark from the list

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_KEY_SERIALIZABLE_BOOKMARK_LIST

public static final String PROPERTY_KEY_SERIALIZABLE_BOOKMARK_LIST

See Also:

• Constant Field Values

Constructor Details

SerializableBookmarkList

public SerializableBookmarkList()

Constructs a new empty list.

May only be called on the server side in DocumentDataProviders.

Method Details

add

public void add(SerializableBookmark serializableBookmark)

Adds the given SerializableBookmark to the list

Parameters:

serializableBookmark - the bookmark to add

remove

public void remove(SerializableBookmark serializableBookmark)

Removes the given bookmark from the list

Parameters:

serializableBookmark - the bookmark to be removed

getAll

public List<SerializableBookmark> getAll()

Returns a list containing all the bookmarks in the list. The returned list should only be used for read operations. Modifications can be made with the add(SerializableBookmark) and remove(SerializableBookmark) methods.