net.sf.basedb.clients.web.extensions.startpage

Interface StartPageAction

All Superinterfaces:

Action

All Known Implementing Classes:

FixedStartPageFactory, StartPageBean

public interface StartPageAction
extends Action

Action for selecting the start page that should be displayed after logging in to BASE.

Since:

3.8

Author:

nicklas

See Also:

FixedStartPageFactory

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Get an optional description of the start page.
java.lang.String	getId() Get the ID of the the action.
java.lang.String	getName() Get the name of the start page.
java.lang.String	getUrl() Get the URL to the start page.

Method Detail

getId

java.lang.String getId()

Get the ID of the the action. This ID is stored as a user setting in BASE and is used to find the correct URL after logging in. It is recommended that an extension use the same ID as the extension itself have.

getName

java.lang.String getName()

Get the name of the start page.

getDescription

java.lang.String getDescription()

Get an optional description of the start page.

getUrl

java.lang.String getUrl()

Get the URL to the start page. The URL should be be an absolute URL. Use $SESSION-ID$ as a placeholder for the current session id. Eg. my_alternate_startpage.jsp?ID=$SESSION-ID$

Returns:

The URL to the page to load, or null to load the regular start page