com.sap.portal.search.service

Class SearchProperties

java.lang.Object
  com.sap.portal.search.service.SearchProperties

public class SearchProperties
extends Object

Represents the properties of search

Constructor Summary

SearchProperties()
Constructs a new instance

Method Summary

List<SearchCategory>	getCategories() Returns the search type categories
SearchProviderConstants.SearchProviderNavigationType	getNavigationType() Returns the type of navigation to the search results window
String	getTemplate() The template of the navigation URL to the search engine, for example, http://search.yahoo.com/search?
String	getWinFeatures() Returns the parameters of the window that displays search results.
Integer	getWinMode() Returns a constant defined by INavigationConstants that indicates how the search results are displayed
void	setCategories(List<SearchCategory> searchCategories) Sets the search type categories
void	setNavigationType(SearchProviderConstants.SearchProviderNavigationType navigationType) Defines the type of navigation to the search results window
void	setTemplate(String template) Sets the search type template
void	setWinFeatures(String winFeatures) Defines the parameters of the window that displays search results.
void	setWinMode(Integer winMode) Defines how the search results are displayed

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchProperties

public SearchProperties()

Constructs a new instance

Method Detail

getTemplate

public String getTemplate()

The template of the navigation URL to the search engine, for example, http://search.yahoo.com/search?p={searchTerms}

Returns:

The template of the navigation URL to the search engine

getWinMode

public Integer getWinMode()

Returns a constant defined by INavigationConstants that indicates how the search results are displayed

Returns:

A constant that indicates how the search results are displayed

getWinFeatures

public String getWinFeatures()

Returns the parameters of the window that displays search results. The default value is equal to SearchProviderConstants WIN_FEATURES: "resizable=yes, scrollbars=yes, status=yes, menubar=yes, location=yes, toolbar=yes"

Returns:

A string representing the parameters of the window that displays search results

getCategories

public List<SearchCategory> getCategories()

Returns the search type categories

Returns:

A list of SearchCategory objects

getNavigationType

public SearchProviderConstants.SearchProviderNavigationType getNavigationType()

Returns the type of navigation to the search results window

Returns:

The navigation type defined by the SearchProviderConstants.SearchProviderNavigationType enum

setTemplate

public void setTemplate(String template)

Sets the search type template

Parameters:

template - the template of the navigation URL to the search engine, for example, "http://search.yahoo.com/search?p={searchTerms}"

setWinMode

public void setWinMode(Integer winMode)

Defines how the search results are displayed

Parameters:

winMode - A constant from the INavigationConstants enum that defines how to display the search results

setWinFeatures

public void setWinFeatures(String winFeatures)

Defines the parameters of the window that displays search results.

Parameters:

winFeatures - The parameters of the window that displays search results; The default value is equal to SearchProviderConstants WIN_FEATURES: "resizable=yes, scrollbars=yes, status=yes, menubar=yes, location=yes, toolbar=yes"

setCategories

public void setCategories(List<SearchCategory> searchCategories)

Sets the search type categories

Parameters:

searchCategories - A list of SearchCategory objects; can be empty if no categories are defined

setNavigationType

public void setNavigationType(SearchProviderConstants.SearchProviderNavigationType navigationType)

Defines the type of navigation to the search results window

Parameters:

navigationType - the navigation type defined by the SearchProviderConstants.SearchProviderNavigationType enum

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/navigation/api	api	EP-PIN