org.osivia.services.search.portlet.service

Interface SearchService

All Known Implementing Classes:

SearchServiceImpl

public interface SearchService

Search portlet service interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCOPE_SELECTOR_ID Search scope selector identifier.

Method Summary

Modifier and Type	Method and Description
SearchForm	getForm(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get form.
SearchSettings	getSettings(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get portlet settings.
void	save(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, SearchSettings settings) Save portlet settings.
String	search(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, SearchForm form) Search.

Field Detail

SCOPE_SELECTOR_ID

static final String SCOPE_SELECTOR_ID

Search scope selector identifier.

See Also:

Constant Field Values

Method Detail

getForm

SearchForm getForm(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
            throws javax.portlet.PortletException

Get form.

Parameters:

portalControllerContext - portal controller context

Returns:

form

Throws:

javax.portlet.PortletException

search

String search(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
              SearchForm form)
       throws javax.portlet.PortletException

Search.

Parameters:

portalControllerContext - portal controller context

form - form

Returns:

redirection URL

Throws:

javax.portlet.PortletException

getSettings

SearchSettings getSettings(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)

Get portlet settings.

Parameters:

portalControllerContext - portal controller context

Returns:

portlet settings

Throws:

javax.portlet.PortletException

save

void save(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
          SearchSettings settings)

Save portlet settings.

Parameters:

portalControllerContext - portal controller context

settings - portlet settings

Throws:

javax.portlet.PortletException