com.sapportals.wcm.rendering.collection

Class SearchSessionEntry

java.lang.Object
  com.sapportals.wcm.rendering.collection.SearchSessionEntry

All Implemented Interfaces:

com.sap.netweaver.kmc.navigationpersistence.IEntry, IRefreshSurvivor, IRenderingEntry, ISearchSessionProvider

Deprecated. As of NetWeaver 7.1

public final class SearchSessionEntry
extends Object
implements ISearchSessionProvider, IRefreshSurvivor, IRenderingEntry

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.sapportals.wcm.rendering.base.IRenderingEntry

IRenderingEntry.InitializationData

Nested classes/interfaces inherited from interface com.sap.netweaver.kmc.navigationpersistence.IEntry

com.sap.netweaver.kmc.navigationpersistence.IEntry.Visibility

Field Summary

Fields inherited from interface com.sap.netweaver.kmc.navigationpersistence.IEntry

IVIEW, SELF, WINDOW

Constructor Summary

SearchSessionEntry()
Deprecated. As of NetWeaver 7.1

SearchSessionEntry(ISearchSession session, RetrievalParameters parameters, String resourcelisttype)
Deprecated. As of NetWeaver 7.1

SearchSessionEntry(ISearchSession session, RetrievalParameters parameters, String resourcelisttype, com.sapportals.wcm.util.uri.RidSet selection)
Deprecated. As of NetWeaver 7.1

SearchSessionEntry(RetrievalParameters parameters, String resourcelisttype)
Deprecated. As of NetWeaver 7.1

Method Summary

void	expand(IResourceContext context) Deprecated. As of NetWeaver 7.1
void	filter() Deprecated. As of NetWeaver 7.1
com.sapportals.wcm.util.uri.RID	getAccessRID(int index) Deprecated. As of NetWeaver 7.1
int	getCurrentIndex() Deprecated. As of NetWeaver 7.1
IResourceList	getList(IResourceContext context) Deprecated. As of NetWeaver 7.1
IResourceList	getList(IResourceContext context, int startindex, int stopindex) Deprecated. As of NetWeaver 7.1
int	getMaxDocsPerPage() Deprecated. As of NetWeaver 7.1
IRenderingEntry	getNewInstance(IRenderingEntry.InitializationData data, com.sap.netweaver.kmc.navigationpersistence.IEntry.Visibility visibility, RetrievalParameters parameters) Deprecated. As of NetWeaver 7.1
ICollection	getParent(IResourceContext context) Deprecated. As of NetWeaver 7.1
Map	getProperties(IResource res) Deprecated. As of NetWeaver 7.1
IResource	getResource(IResourceContext context, int index) Deprecated. As of NetWeaver 7.1
RetrievalParameters	getRetrievalParameters() Deprecated. As of NetWeaver 7.1
com.sapportals.wcm.util.uri.IRidList	getRIDList() Deprecated. As of NetWeaver 7.1
ISearchSession	getSearchSession() Deprecated. As of NetWeaver 7.1
com.sapportals.wcm.util.uri.RidSet	getSelection() Deprecated. As of NetWeaver 7.1
IResourceList	getSelection(IResourceContext context) Deprecated. As of NetWeaver 7.1
ITypedResourceList	getTypedResourceList(IResourceContext context) Deprecated. As of NetWeaver 7.1
com.sap.netweaver.kmc.navigationpersistence.IEntry.Visibility	getVisibility() Deprecated. As of NetWeaver 7.1
boolean	hasMore() Deprecated. As of NetWeaver 7.1
boolean	isVolatile() Deprecated. As of NetWeaver 7.1
void	refresh(IResourceContext context) Deprecated. As of NetWeaver 7.1
void	setCurrentIndex(int index, IResourceContext context) Deprecated. As of NetWeaver 7.1
void	setHasMore(boolean flag) Deprecated. As of NetWeaver 7.1
void	setMaxDocsPerPage(int maxDocsPerPage) Deprecated. As of NetWeaver 7.1
void	setSearchSession(ISearchSession searchSession) Deprecated. As of NetWeaver 7.1
void	setSelection(boolean selected) Deprecated. As of NetWeaver 7.1
void	setSelection(com.sapportals.wcm.util.uri.RidSet set) Deprecated. As of NetWeaver 7.1
void	setSession(ISearchSession session) Deprecated. As of NetWeaver 7.1
void	shrink() Deprecated. As of NetWeaver 7.1
int	size() Deprecated. As of NetWeaver 7.1

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchSessionEntry

public SearchSessionEntry()

Deprecated. As of NetWeaver 7.1

SearchSessionEntry

public SearchSessionEntry(ISearchSession session,
                          RetrievalParameters parameters,
                          String resourcelisttype,
                          com.sapportals.wcm.util.uri.RidSet selection)
                   throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

Throws:

com.sapportals.wcm.WcmException

SearchSessionEntry

public SearchSessionEntry(ISearchSession session,
                          RetrievalParameters parameters,
                          String resourcelisttype)
                   throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

Throws:

com.sapportals.wcm.WcmException

SearchSessionEntry

public SearchSessionEntry(RetrievalParameters parameters,
                          String resourcelisttype)
                   throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

Throws:

com.sapportals.wcm.WcmException

Method Detail

setSession

public void setSession(ISearchSession session)
                throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

TODO this is a duplicate method just with a different name *

Throws:

com.sapportals.wcm.WcmException

isVolatile

public boolean isVolatile()

Deprecated. As of NetWeaver 7.1

Specified by:

isVolatile in interface IRenderingEntry

Returns:

flag stating if the status might be deleted after the first click or not. return true, if it might be deleted.

getParent

public ICollection getParent(IResourceContext context)

Deprecated. As of NetWeaver 7.1

Specified by:

getParent in interface IRenderingEntry

Parameters:

context - the context for the current request. Must not be null.

Returns:

might be null, if the entry does not support hierarchical structures

getCurrentIndex

public int getCurrentIndex()

Deprecated. As of NetWeaver 7.1

Specified by:

getCurrentIndex in interface IRenderingEntry

Returns:

the current index where to start retrieval of IResources.

getSearchSession

public ISearchSession getSearchSession()

Deprecated. As of NetWeaver 7.1

Description copied from interface: ISearchSessionProvider

get search session from SearchRendererStatus

Specified by:

getSearchSession in interface ISearchSessionProvider

setSearchSession

public void setSearchSession(ISearchSession searchSession)

Deprecated. As of NetWeaver 7.1

getMaxDocsPerPage

public int getMaxDocsPerPage()

Deprecated. As of NetWeaver 7.1

setMaxDocsPerPage

public void setMaxDocsPerPage(int maxDocsPerPage)

Deprecated. As of NetWeaver 7.1

filter

public void filter()

Deprecated. As of NetWeaver 7.1

refresh

public void refresh(IResourceContext context)
             throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

central refresh of list to be displayed

Specified by:

refresh in interface IRenderingEntry

Parameters:

context - the context for the current request. Must not be null.

Throws:

com.sapportals.wcm.WcmException

setHasMore

public void setHasMore(boolean flag)

Deprecated. As of NetWeaver 7.1

hasMore

public boolean hasMore()

Deprecated. As of NetWeaver 7.1

Specified by:

hasMore in interface IRenderingEntry

Returns:

flag telling, if the entry might be able to retrieve more resources than are currently returned by the IRenderingEntry.size() method.

setCurrentIndex

public void setCurrentIndex(int index,
                            IResourceContext context)
                     throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

Description copied from interface: IRenderingEntry

If, for example, a list of 100 resources is stored in this entry, the initial index will be null. If 20 resources are displayed per screen, the paging command "show 21 to 40" should lead to a call of this method with the value 20.

Specified by:

setCurrentIndex in interface IRenderingEntry

Parameters:

index - depending on the implementation, a value that is index >= (this.size()-1) might lead to an IndexOutOfBoundsException.

context - the context for the current request. Must not be null

Throws:

com.sapportals.wcm.WcmException

setSelection

public void setSelection(boolean selected)

Deprecated. As of NetWeaver 7.1

Specified by:

setSelection in interface IRenderingEntry

Parameters:

selected - selects all resources currently stored within the implementation, if the parameter is set to true. Deselects all resources otherwise. If more resources are stored within the entry at a later time (for example, if the entry supports a "hasMore" mode), the implementation has to specify if these additional resources are selected or not.

setSelection

public void setSelection(com.sapportals.wcm.util.uri.RidSet set)

Deprecated. As of NetWeaver 7.1

Specified by:

setSelection in interface IRenderingEntry

Parameters:

set - of accessRIDs of resources that should be set to selected, after this method has been carried out. Resources that were set to selected before and are not included in this set, will not be selected after this call was carried out.

size

public int size()

Deprecated. As of NetWeaver 7.1

Specified by:

size in interface IRenderingEntry

Returns:

the current size of AccessRIDs stored in the instance

getRetrievalParameters

public RetrievalParameters getRetrievalParameters()

Deprecated. As of NetWeaver 7.1

Specified by:

getRetrievalParameters in interface IRenderingEntry

Returns:

getAccessRID

public com.sapportals.wcm.util.uri.RID getAccessRID(int index)

Deprecated. As of NetWeaver 7.1

Specified by:

getAccessRID in interface IRenderingEntry

Parameters:

index - the index to retrieve the accessRID for. Might result in an IndexOutOfBoundsException

Returns:

the accessRID of the resource stored at this position

getList

public IResourceList getList(IResourceContext context,
                             int startindex,
                             int stopindex)
                      throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

Specified by:

getList in interface IRenderingEntry

Parameters:

context - the context for the current request. Must not be null.

startindex - the first resource to retrieve

stopindex - the last resource to retrieve

Returns:

a new IResourceList instance, that contains the specified resources. If not all resources could be retrieved, for example because of security problems, the list might be smaller than expected.

Throws:

com.sapportals.wcm.WcmException

getList

public IResourceList getList(IResourceContext context)
                      throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

Description copied from interface: IRenderingEntry

This is the potentially most expensive call, because all resources stored will be instantiated.

Specified by:

getList in interface IRenderingEntry

Parameters:

context - the context for the current request. Must not be null.

Returns:

the complete list of resources stored in this entry.

Throws:

com.sapportals.wcm.WcmException

getResource

public IResource getResource(IResourceContext context,
                             int index)
                      throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

Specified by:

getResource in interface IRenderingEntry

Parameters:

context - the context for the current request. Must not be null.

index - the index to retrieve the resource for. Might result in an IndexOutOfBoundsException

Returns:

the resource stored at this index

Throws:

com.sapportals.wcm.WcmException

getRIDList

public com.sapportals.wcm.util.uri.IRidList getRIDList()

Deprecated. As of NetWeaver 7.1

Specified by:

getRIDList in interface IRenderingEntry

Returns:

a list of all the accessRIDs of the stored resources in the order the resources are stored. Modifications of this list must not modify the ridlist stored within the implementation.

getSelection

public com.sapportals.wcm.util.uri.RidSet getSelection()

Deprecated. As of NetWeaver 7.1

Specified by:

getSelection in interface IRenderingEntry

Returns:

a set containing all accessRIDs of resources that have been selected. Modifications to this set must not modify the selection stored within the implementation.

getSelection

public IResourceList getSelection(IResourceContext context)
                           throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

Specified by:

getSelection in interface IRenderingEntry

Parameters:

context - the context for the current request. Must not be null.

Returns:

a new ResourceList containing only resources that have been selected. The ordering of this list might not be identical to the ordering of the resourcelist itself.

Throws:

com.sapportals.wcm.WcmException

getTypedResourceList

public ITypedResourceList getTypedResourceList(IResourceContext context)
                                        throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

Description copied from interface: IRenderingEntry

This is the potentially most expensive call, because all resources stored will be instantiated.

Specified by:

getTypedResourceList in interface IRenderingEntry

Parameters:

context - the context for the current request. Must not be null.

Returns:

a new instance of an ITypedResourceList containing all resources currently managed by this instance

Throws:

com.sapportals.wcm.WcmException

shrink

public void shrink()

Deprecated. As of NetWeaver 7.1

Specified by:

shrink in interface com.sap.netweaver.kmc.navigationpersistence.IEntry

expand

public void expand(IResourceContext context)

Deprecated. As of NetWeaver 7.1

Specified by:

expand in interface com.sap.netweaver.kmc.navigationpersistence.IEntry

getProperties

public Map getProperties(IResource res)
                  throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

Throws:

com.sapportals.wcm.WcmException

getVisibility

public com.sap.netweaver.kmc.navigationpersistence.IEntry.Visibility getVisibility()

Deprecated. As of NetWeaver 7.1

Specified by:

getVisibility in interface com.sap.netweaver.kmc.navigationpersistence.IEntry

getNewInstance

public IRenderingEntry getNewInstance(IRenderingEntry.InitializationData data,
                                      com.sap.netweaver.kmc.navigationpersistence.IEntry.Visibility visibility,
                                      RetrievalParameters parameters)
                               throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

Description copied from interface: IRenderingEntry

this is the standard call to create a new instance of a rendering entry. It must only be called by the PersistenceFactory, not by the classes within the rendering framework.

Specified by:

getNewInstance in interface IRenderingEntry

Parameters:

data - must not be null

visibility - the visibility for this entry, must not be null

parameters - must not be null

Returns:

a new instance of a rendering entry.

Throws:

com.sapportals.wcm.WcmException

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/nonwduideprecated	api	EP-KM-CM