com.sapportals.wcm.control.util.search

Interface ISearchComponent

public interface ISearchComponent

Method Summary

Modifier and Type	Method and Description
String	getControlID() Deprecated. As of NetWeaver 7.1
ResultList	getMessageList() Deprecated. As of NetWeaver 7.1
Properties	getPersistenceMap() Deprecated. As of NetWeaver 7.1
SearchParamsMap	getSearchParamsMap() Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.Component	renderComponent() Deprecated. As of NetWeaver 7.1
void	setDynPage(com.sapportals.htmlb.page.DynPage dynPage) Deprecated. As of NetWeaver 7.1
void	setPersistenceMap(Properties propMap) Deprecated. As of NetWeaver 7.1
void	setSearchParamsMap(SearchParamsMap searchParamsMap) Deprecated. As of NetWeaver 7.1

Method Detail

getSearchParamsMap

SearchParamsMap getSearchParamsMap()

Deprecated. As of NetWeaver 7.1

Returns the universal map for the communication between search dialog (parent) and search components (children). This information is gathered and accumulated. All relevant and supported constants are provided in class SearchParamMapConst. Mind to fulfil the respective types. Examples are:
- PARAM_SEARCH_IN for the search scope
- PARAM_SEARCH_QUERY_ENTRIES for the relevant search query entries
- PARAM_INDICES_LIST for the list of indexes to be searched on
....

Returns:

SearchParamsMap with info about the current setting of the search component

See Also:

setSearchParamsMap(SearchParamsMap)

setSearchParamsMap

void setSearchParamsMap(SearchParamsMap searchParamsMap)

Deprecated. As of NetWeaver 7.1

Sets current accumulated search information.

Parameters:

searchParamsMap -

See Also:

setPersistenceMap(Properties)

setPersistenceMap

void setPersistenceMap(Properties propMap)

Deprecated. As of NetWeaver 7.1

Data map of type Properties that was persisted in parent search dialog. Enables the storage of user transaction relevant information beyond a round trip.

Parameters:

propMap - containing persistence relevant data.

getPersistenceMap

Properties getPersistenceMap()

Deprecated. As of NetWeaver 7.1

Returns the component relevant date that needs to be persisted beyond a round trip.

Returns:

Properties map that contains component relevant data.

See Also:

setPersistenceMap(Properties)

getMessageList

ResultList getMessageList()

Deprecated. As of NetWeaver 7.1

All collected relevant messages (e.g. user input errors) of the component should be provide here.

Returns:

List of messages and errors occurred during transaction.

getControlID

String getControlID()

Deprecated. As of NetWeaver 7.1

Provide a unique control identifier.

Returns:

Unique Control ID

setDynPage

void setDynPage(com.sapportals.htmlb.page.DynPage dynPage)

Deprecated. As of NetWeaver 7.1

Provides DynPage to enable read out of HTMLB user interface components.

Parameters:

dynPage -

renderComponent

com.sapportals.htmlb.Component renderComponent()
                                        throws SearchException

Deprecated. As of NetWeaver 7.1

Renders the search component.

Returns:

HTMLB user interface component

Throws:

SearchException