public final class SearchSessionEntry extends Object implements ISearchSessionProvider, IRefreshSurvivor, IRenderingEntry
SearchRendererStatus
IRenderingEntry.InitializationData
Constructor and Description |
---|
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,
RidSet selection)
Deprecated.
As of NetWeaver 7.1
|
SearchSessionEntry(RetrievalParameters parameters,
String resourcelisttype)
Deprecated.
As of NetWeaver 7.1
|
Modifier and Type | Method and Description |
---|---|
void |
expand(IResourceContext context)
Deprecated.
As of NetWeaver 7.1
|
void |
filter()
Deprecated.
As of NetWeaver 7.1
|
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
|
IRidList |
getRIDList()
Deprecated.
As of NetWeaver 7.1
|
ISearchSession |
getSearchSession()
Deprecated.
As of NetWeaver 7.1
|
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(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
|
public SearchSessionEntry()
public SearchSessionEntry(ISearchSession session, RetrievalParameters parameters, String resourcelisttype, RidSet selection) throws WcmException
WcmException
public SearchSessionEntry(ISearchSession session, RetrievalParameters parameters, String resourcelisttype) throws WcmException
WcmException
public SearchSessionEntry(RetrievalParameters parameters, String resourcelisttype) throws WcmException
WcmException
public void setSession(ISearchSession session) throws WcmException
WcmException
public boolean isVolatile()
isVolatile
in interface IRenderingEntry
true
, if it might be deleted.public ICollection getParent(IResourceContext context)
getParent
in interface IRenderingEntry
context
- the context for the current request. Must not be null
.null
, if the entry does not support hierarchical structurespublic int getCurrentIndex()
getCurrentIndex
in interface IRenderingEntry
IResources
.public ISearchSession getSearchSession()
ISearchSessionProvider
getSearchSession
in interface ISearchSessionProvider
public void setSearchSession(ISearchSession searchSession)
public int getMaxDocsPerPage()
public void setMaxDocsPerPage(int maxDocsPerPage)
public void filter()
public void refresh(IResourceContext context) throws WcmException
refresh
in interface IRenderingEntry
context
- the context for the current request. Must not be null
.WcmException
public void setHasMore(boolean flag)
public boolean hasMore()
hasMore
in interface IRenderingEntry
IRenderingEntry.size()
method.public void setCurrentIndex(int index, IResourceContext context) throws WcmException
IRenderingEntry
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
.setCurrentIndex
in interface IRenderingEntry
index
- depending on the implementation, a value that is
index is grater than or equal to (this.size()-1)
might lead to an IndexOutOfBoundsException.
context
- the context for the current request. Must not be null
WcmException
public void setSelection(boolean selected)
setSelection
in interface IRenderingEntry
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.public void setSelection(RidSet set)
setSelection
in interface IRenderingEntry
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.public int size()
size
in interface IRenderingEntry
public RetrievalParameters getRetrievalParameters()
getRetrievalParameters
in interface IRenderingEntry
public RID getAccessRID(int index)
getAccessRID
in interface IRenderingEntry
index
- the index to retrieve the accessRID for. Might result in an
IndexOutOfBoundsException
public IResourceList getList(IResourceContext context, int startindex, int stopindex) throws WcmException
getList
in interface IRenderingEntry
context
- the context for the current request. Must not be null
.startindex
- the first resource to retrievestopindex
- the last resource to retrieveIResourceList
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.WcmException
public IResourceList getList(IResourceContext context) throws WcmException
IRenderingEntry
getList
in interface IRenderingEntry
context
- the context for the current request. Must not be null
.WcmException
public IResource getResource(IResourceContext context, int index) throws WcmException
getResource
in interface IRenderingEntry
context
- the context for the current request. Must not be null
.index
- the index to retrieve the resource for. Might result in an
IndexOutOfBoundsException
WcmException
public IRidList getRIDList()
getRIDList
in interface IRenderingEntry
public RidSet getSelection()
getSelection
in interface IRenderingEntry
public IResourceList getSelection(IResourceContext context) throws WcmException
getSelection
in interface IRenderingEntry
context
- the context for the current request. Must not be null
.WcmException
public ITypedResourceList getTypedResourceList(IResourceContext context) throws WcmException
IRenderingEntry
getTypedResourceList
in interface IRenderingEntry
context
- the context for the current request. Must not be null
.ITypedResourceList
containing all
resources currently managed by this instanceWcmException
public void shrink()
shrink
in interface com.sap.netweaver.kmc.navigationpersistence.IEntry
public void expand(IResourceContext context)
expand
in interface com.sap.netweaver.kmc.navigationpersistence.IEntry
public Map getProperties(IResource res) throws WcmException
WcmException
public com.sap.netweaver.kmc.navigationpersistence.IEntry.Visibility getVisibility()
getVisibility
in interface com.sap.netweaver.kmc.navigationpersistence.IEntry
public IRenderingEntry getNewInstance(IRenderingEntry.InitializationData data, com.sap.netweaver.kmc.navigationpersistence.IEntry.Visibility visibility, RetrievalParameters parameters) throws WcmException
IRenderingEntry
PersistenceFactory
, not by the
classes within the rendering framework.getNewInstance
in interface IRenderingEntry
data
- must not be null
visibility
- the visibility for this entry, must not be null
parameters
- must not be null
WcmException
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com]
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice