com.sapportals.wcm.rendering.base

Interface IRenderingEntry

All Superinterfaces:

com.sap.netweaver.kmc.navigationpersistence.IEntry

All Known Implementing Classes:

HierarchicalEntry, SearchSessionEntry

Deprecated. As of NetWeaver 7.1

public interface IRenderingEntry
extends com.sap.netweaver.kmc.navigationpersistence.IEntry

Nested Class Summary

static class

IRenderingEntry.InitializationData Deprecated. As of NetWeaver 7.1

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

Method Summary

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
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
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
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
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	setSelection(boolean selected) Deprecated. As of NetWeaver 7.1
void	setSelection(RidSet set) Deprecated. As of NetWeaver 7.1
int	size() Deprecated. As of NetWeaver 7.1

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

expand, getVisibility, shrink

Method Detail

isVolatile

boolean isVolatile()

Deprecated. As of NetWeaver 7.1

Returns:

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

getCurrentIndex

int getCurrentIndex()

Deprecated. As of NetWeaver 7.1

Returns:

the current index where to start retrieval of IResources.

setCurrentIndex

void setCurrentIndex(int index,
                     IResourceContext context)
                     throws WcmException

Deprecated. As of NetWeaver 7.1

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.

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:

WcmException

getResource

IResource getResource(IResourceContext context,
                      int index)
                      throws WcmException

Deprecated. As of NetWeaver 7.1

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:

WcmException

getAccessRID

RID getAccessRID(int index)

Deprecated. As of NetWeaver 7.1

Parameters:

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

Returns:

the accessRID of the resource stored at this position

getRIDList

IRidList getRIDList()

Deprecated. As of NetWeaver 7.1

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

RidSet getSelection()

Deprecated. As of NetWeaver 7.1

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.

getRetrievalParameters

RetrievalParameters getRetrievalParameters()

Deprecated. As of NetWeaver 7.1

Returns:

the retrieval parameters stored within the entry. Must not be null

setSelection

void setSelection(boolean selected)

Deprecated. As of NetWeaver 7.1

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

void setSelection(RidSet set)

Deprecated. As of NetWeaver 7.1

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

int size()

Deprecated. As of NetWeaver 7.1

Returns:

the current size of AccessRIDs stored in the instance

hasMore

boolean hasMore()

Deprecated. As of NetWeaver 7.1

Returns:

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

getParent

ICollection getParent(IResourceContext context)
                      throws WcmException

Deprecated. As of NetWeaver 7.1

Parameters:

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

Returns:

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

Throws:

WcmException

getList

IResourceList getList(IResourceContext context)
                      throws WcmException

Deprecated. As of NetWeaver 7.1

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

Parameters:

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

Returns:

the complete list of resources stored in this entry.

Throws:

WcmException

getList

IResourceList getList(IResourceContext context,
                      int startindex,
                      int stopindex)
                      throws WcmException

Deprecated. As of NetWeaver 7.1

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:

WcmException

getSelection

IResourceList getSelection(IResourceContext context)
                           throws WcmException

Deprecated. As of NetWeaver 7.1

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:

WcmException

getTypedResourceList

ITypedResourceList getTypedResourceList(IResourceContext context)
                                        throws WcmException

Deprecated. As of NetWeaver 7.1

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

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:

WcmException

refresh

void refresh(IResourceContext context)
             throws WcmException

Deprecated. As of NetWeaver 7.1

This is the potentially most expensive call, because all resources stored will be instantiated as well as filtering and sorting are carried out.

Parameters:

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

Throws:

WcmException

getNewInstance

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

Deprecated. As of NetWeaver 7.1

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.

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:

WcmException

Access Rights

This class can be accessed from:

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