org.olat.bookmark
Interface BookmarkHandler

All Known Implementing Classes:

CatalogBookmarkHandler, RepoBookmarkHandler

public interface BookmarkHandler

Description:
The bookmark launch handler implements the launching code of a bookmark. The handler must check if the given bookmark must be handled by this handler. It must only launch bookmarks that are launchable by this handler.

The handlers must be added to the appropriate spring config file. See the RepoBookmarkHandler for an example

When you create a new bookmark handler, you should usually also implement a JumpInHandlerFactory for this type of bookmark!

Initial Date: 28.05.2008

Author:

gnaegi

Method Summary

java.lang.String	createJumpInURL(Bookmark bookmark) Create a fully qualified URL that can be used to launch this bookmark e.g.
boolean	tryToLaunch(Bookmark bookmark, UserRequest ureq, WindowControl wControl) Try to launch the given OLAT resource

Method Detail

tryToLaunch

boolean tryToLaunch(Bookmark bookmark,
                    UserRequest ureq,
                    WindowControl wControl)

Try to launch the given OLAT resource

Parameters:

bookmark - The bookmark to be launched

ureq. - The current user request

wControl - The current window control

Returns:

TRUE: this handler was responsible for launching this bookmark. Note that the launching process could have failed e.g. because the bookmark resource does not exist anymore. FALSE: this handler is not responsible for this bookmark, another handler should try it.

createJumpInURL

java.lang.String createJumpInURL(Bookmark bookmark)

Create a fully qualified URL that can be used to launch this bookmark e.g. from a browser bookmark or an RSS feed document

Parameters:

bookmark -

Returns:

URL or NULL if not successful