com.sapportals.wcm.rendering.collection
Class SearchRendererStatus

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.collection_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.rendering.collection.AbstractRendererStatus
        |
        +--com.sapportals.wcm.rendering.collection.SearchRendererStatus

All Implemented Interfaces:

IConfigurableRendererStatus, IControlStatus, IMassDataControlStatus, IRefreshSurvivor, IRendererStatus, ISearchSessionProvider, IVolatileStatus

public class SearchRendererStatus

extends AbstractRendererStatus

implements ISearchSessionProvider, IRefreshSurvivor

The SearchRendererStatus class renders a search resultinput. A search search query gets passed via CFlSearchEvent to SearchResultControl. Search is done in SearchResultControl via federated search manager of WCM. Copyright (c) SAP Portals Europe GmbH 2001

See Also:

SearchRendererStatus

Inner classes inherited from class com.sapportals.wcm.rendering.collection.AbstractRendererStatus

AbstractRendererStatus.CompleteResource, AbstractRendererStatus.CompleteResourceComparator

Fields inherited from class com.sapportals.wcm.rendering.collection.AbstractRendererStatus

actions, context, list

Fields inherited from interface com.sapportals.wcm.rendering.base.IRendererStatus

DESELECT_ALL, ID, NAME, SELECT_ALL

Constructor Summary

SearchRendererStatus()

Method Summary

void	filter() filters the current IResourceList attribute of the status using the set IResourceListFilter and the IParameters.
java.util.List	getActions() returns a list with all IExecutable s defined by the implementing class
int	getEntrySize() returns the number of entries that are managed within this status
int	getMaxDocsPerPage()
IConfigurableRendererStatus	getNewInstance()
ISearchSession	getSearchSession() get search session from SearchRendererStatus
ITypedResourceList	getTypedResourceList() returns the ITypedResourceList, whose elements are handled within this status.
boolean	hasMore() flag telling, if all resources available for the given parent or the given resourcelist are included in the presently returned resourcelist.
void	refresh() central refresh of list to be displayed
void	setCurrentIndex(int index) sets the index-attribute of the status to the given value.
void	setHasMore(boolean flag)
void	setMaxDocsPerPage(int maxDocsPerPage)
void	setParameters(java.util.Hashtable searchParameters) set search parameters that are important for rendering info (docs per page, nof cats, search cascade)
void	setSearchSession(ISearchSession searchSession)
void	setSession(ISearchSession session)

Methods inherited from class com.sapportals.wcm.rendering.collection.AbstractRendererStatus

execute, execute, getAction, getComparator, getCurrentIndex, getField, getFields, getFieldSet, getFieldSet, getFilter, getFilterParameters, getID, getMassFields, getParameters, getParent, getPropertyColumns, getResource, getResourceList, getResourceTypeMapping, getSelectedResources, getSortDefintion, getStatusInformation, initializeSelectionList, isVolatile, setComparator, setFilter, setFilterParameters, setID, setParent, setPropertyColumns, setResourceTypeMapping, setSortDefinition, setTypedResourceList, sort

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchRendererStatus

public SearchRendererStatus()

Method Detail

setSession

public void setSession(ISearchSession session)
                throws WcmException

getSearchSession

public ISearchSession getSearchSession()

Description copied from interface: ISearchSessionProvider

get search session from SearchRendererStatus

Specified by:

getSearchSession in interface ISearchSessionProvider

setSearchSession

public void setSearchSession(ISearchSession searchSession)

getMaxDocsPerPage

public int getMaxDocsPerPage()

setMaxDocsPerPage

public void setMaxDocsPerPage(int maxDocsPerPage)

filter

public void filter()

Description copied from class: AbstractRendererStatus

filters the current IResourceList attribute of the status using the set IResourceListFilter and the IParameters. If one of these is null, no filtering will be done, but a logging entry is written. Also, if the list has been filtered before and no new information has been provided by either
setting a new IResourceListFilter
setting new IParameters or
calling the AbstractRendererStatus.refresh() method
the method will not call the filter algorithm again due to performance reasons.
Also, this method will set the current index back to 0, because the index as it was might exceed the number of elements left over after the filtering.
The list of selected resources will be reseted as well, so no elements will be selected.

Overrides:

filter in class AbstractRendererStatus

Following copied from interface: com.sapportals.wcm.rendering.base.IRendererStatus

Throws:

WcmException - if the filtering class throws it

refresh

public void refresh()
             throws WcmException

central refresh of list to be displayed

Overrides:

refresh in class AbstractRendererStatus

setParameters

public void setParameters(java.util.Hashtable searchParameters)

set search parameters that are important for rendering info (docs per page, nof cats, search cascade)

Overrides:

setParameters in class AbstractRendererStatus

setHasMore

public void setHasMore(boolean flag)

hasMore

public boolean hasMore()

Description copied from class: AbstractRendererStatus

flag telling, if all resources available for the given parent or the given resourcelist are included in the presently returned resourcelist.

Overrides:

hasMore in class AbstractRendererStatus

Following copied from class: com.sapportals.wcm.rendering.collection.AbstractRendererStatus

Returns:

false, if all resources are included

getEntrySize

public int getEntrySize()

Description copied from interface: IMassDataControlStatus

returns the number of entries that are managed within this status

Overrides:

getEntrySize in class AbstractRendererStatus

Following copied from interface: com.sapportals.wcm.util.controlstatus.IMassDataControlStatus

Returns:

entrySize

setCurrentIndex

public void setCurrentIndex(int index)
                     throws WcmException

Description copied from interface: IRendererStatus

sets the index-attribute of the status to the given value. This is needed e.g. to store the part of the resourcelist that is currently displayed within an iView.

Overrides:

setCurrentIndex in class AbstractRendererStatus

Following copied from interface: com.sapportals.wcm.rendering.base.IRendererStatus

Throws:

an - IndexOutOfBoundsException, if it is set to a value that exceeds the number of IResources within this status. If not all elements of the ITypedResourceList or all children of the ICollection have been retrieved yet (e.g. because of performance reasons), this method might trigger a refresh of the list and increase that number.

getTypedResourceList

public ITypedResourceList getTypedResourceList()

Description copied from interface: IRendererStatus

returns the ITypedResourceList, whose elements are handled within this status. Might be null or might be of size 0.

Overrides:

getTypedResourceList in class AbstractRendererStatus

getActions

public java.util.List getActions()

Description copied from interface: IControlStatus

returns a list with all IExecutable s defined by the implementing class

Following copied from interface: com.sapportals.wcm.util.controlstatus.IControlStatus

Returns:

actions

getNewInstance

public IConfigurableRendererStatus getNewInstance()