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

Class StartPageBean

java.lang.Object

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

All Implemented Interfaces:

StartPageAction, Action

public class StartPageBean
extends Object
implements StartPageAction

A simple bean-like implementation of the StartPageAction interface.

Since:

3.8

Author:

nicklas

Field Summary

Fields

Modifier and Type	Field	Description
private String	description
private String	id
private String	name
private String	url

Constructor Summary

Constructors

Constructor	Description
StartPageBean()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Get an optional description of the start page.
String	getId()	Get the ID of the the action.
String	getName()	Get the name of the start page.
String	getUrl()	Get the URL to the start page.
void	setDescription(String description)
void	setId(String id)
void	setName(String name)
void	setUrl(String url)

Methods inherited from class java.lang.Object

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

Field Details

id

private String id

name

private String name

description

private String description

url

private String url

Constructor Details

StartPageBean

public StartPageBean()

Method Details

getId

public String getId()

Description copied from interface: StartPageAction

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.

Specified by:

getId in interface StartPageAction

getName

public String getName()

Description copied from interface: StartPageAction

Get the name of the start page.

Specified by:

getName in interface StartPageAction

getDescription

public String getDescription()

Description copied from interface: StartPageAction

Get an optional description of the start page.

Specified by:

getDescription in interface StartPageAction

getUrl

public String getUrl()

Description copied from interface: StartPageAction

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$

Specified by:

getUrl in interface StartPageAction

Returns:

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

setId

public void setId(String id)

setName

public void setName(String name)

setDescription

public void setDescription(String description)

setUrl

public void setUrl(String url)