uk.ac.cam.caret.sakai.rwiki.tool.bean

Class SearchBean

java.lang.Object

uk.ac.cam.caret.sakai.rwiki.tool.bean.SearchBean

public class SearchBean
extends Object

Bean for helping with the search view

Author:

andrew

Field Summary

Fields

Modifier and Type	Field and Description
static String	PAGE_PARAM Parameter name for requesting search terms.
static String	REALM_PARAM Parameter name for the realm to which the search is restricted.
static String	SEARCH_PARAM Parameter name for requesting search terms.

Constructor Summary

Constructors

Constructor and Description
SearchBean(String search, String realm, uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService objectService) Creates a searchBean

Method Summary

Methods

Modifier and Type	Method and Description
String	getRealm() Gets the current search realm
String	getSearch() Gets the current search request
List	getSearchResults() Perform the search
List	search() Perform the search
void	setRWikiObjectService(uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService objectService) Set the RWikiObjectService for searching from

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_PARAM

public static final String SEARCH_PARAM

Parameter name for requesting search terms.

See Also:

Constant Field Values

PAGE_PARAM

public static final String PAGE_PARAM

Parameter name for requesting search terms.

See Also:

Constant Field Values

REALM_PARAM

public static final String REALM_PARAM

Parameter name for the realm to which the search is restricted.

See Also:

Constant Field Values

Constructor Detail

SearchBean

public SearchBean(String search,
          String realm,
          uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService objectService)

Creates a searchBean

Parameters:

search -

user -

realm -

objectService -

Method Detail

setRWikiObjectService

public void setRWikiObjectService(uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService objectService)

Set the RWikiObjectService for searching from

Parameters:

objectService -

getSearch

public String getSearch()

Gets the current search request

Returns:

current search request

getRealm

public String getRealm()

Gets the current search realm

Returns:

current search realm

getSearchResults

public List getSearchResults()

Perform the search

Returns:

a list of page names that match the search criteria

search

public List search()

Perform the search

Returns:

a list of page names that match the search criteria