edu.wisc.my.portlets.bookmarks.dao

Interface BookmarkStore

All Known Implementing Classes:

FileSystemBookmarkStore, HibernateBookmarkStore, TemplateUserBookmarkStore

public interface BookmarkStore

The BookmarkStore provides the APIs to use for storing, retrieving and removing BookmarkSets from a persitent store.

Version:

$Revision: 12161 $

Author:

Eric Dalquist eric.dalquist@doit.wisc.edu

Method Summary

Methods

Modifier and Type	Method and Description
BookmarkSet	createBookmarkSet(String owner, String name) Creates a BookmarkSet and stores it in the persistent store.
BookmarkSet	getBookmarkSet(String owner, String name) Gets a BookmarkSet for the specified owner and name.
void	removeBookmarkSet(String owner, String name) Removes a BookmarkSet from the persistent store.
void	storeBookmarkSet(BookmarkSet bookmarkSet) Stores a new BookmarkSet or updates an existing BookmarkSet.

Method Detail

getBookmarkSet

BookmarkSet getBookmarkSet(String owner,
                         String name)

Gets a BookmarkSet for the specified owner and name. If no BookmarkSet can be found for the owner and name null is retuned.

Parameters:

owner - The owner of the BookmarkSet to retreive.

name - The name of the BookmarkSet to retrieve.

Returns:

The BookmarkSet for the name and owner, null if one is not found for the owner and name.

storeBookmarkSet

void storeBookmarkSet(BookmarkSet bookmarkSet)

Stores a new BookmarkSet or updates an existing BookmarkSet. BookmarkSets are keyed uniquely using the name and owner fields.

Parameters:

bookmarkSet - The BookmarkSet to persist. TODO should this return something?

removeBookmarkSet

void removeBookmarkSet(String owner,
                     String name)

Removes a BookmarkSet from the persistent store. If a BookmarkSet matching the owner and name cannot be found this is a noop.

Parameters:

owner - The owner of the BookmarkSet to remove.

name - The name of the BookmarkSet to remove.

createBookmarkSet

BookmarkSet createBookmarkSet(String owner,
                            String name)

Creates a BookmarkSet and stores it in the persistent store.

Parameters:

owner - The owner of the BookmarkSet to create.

name - The name of the BookmarkSet to create.

Returns:

The new BookmarkSet.