com.sapportals.wcm.repository.service.layout.info

Class RenderObjectContainer

java.lang.Object
  com.sapportals.wcm.repository.service.layout.info.RenderObjectContainer

public final class RenderObjectContainer
extends Object

acts as a container keeping a map of IRenderObjectInfo instances. If the info for the requested RenderObjectKey does not exist, it will be created, added to the map and returned to the calling class. If the info for the requested key has already been created, the existing info will be returned. The calling class is then free to modify the data of this info. This ensures that throughout the rendering process all information suppliers for a certan rendering object combine their information in a single IRenderObjectInfo.
This class should only be constructed by the IRenderingContainer which will return this instance to calling classes via its getRenderObjectContainer method.

Constructor Summary

RenderObjectContainer(IResourceContext context)
creates a new, empty container.

Method Summary

com.sapportals.wcm.util.uri.RID	getMainRID()
IRenderObjectInfo	getRenderObject(RenderObjectKey key) returns the IRenderObjectInfo that is mapped to the supplied key parameter.
RenderObjectInfoList	getRenderObjects(IRenderObjectInfo.RenderObjectCategory category)
Status	getStatus()
Set	keys()
void	setMainRID(com.sapportals.wcm.util.uri.RID rid)
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderObjectContainer

public RenderObjectContainer(IResourceContext context)

creates a new, empty container.

Parameters:

context, - must not be null

Method Detail

setMainRID

public void setMainRID(com.sapportals.wcm.util.uri.RID rid)

Parameters:

rid - the accessrid of the current ICollection that is viewed here.

getMainRID

public com.sapportals.wcm.util.uri.RID getMainRID()

Returns:

the accessrid of the ICollection that was viewed. Might be null, if e.g. a ITypedResourceList is viewed

size

public int size()

Returns:

the number of IRenderObjectInfo elements that are stored within this container.

getStatus

public Status getStatus()

keys

public Set keys()

Returns:

a copied Set of the internally hold set of RenderObjectKey instances. If no entries have been created within this container, this method will return a set with Set.size() == 0, but never null.

getRenderObject

public IRenderObjectInfo getRenderObject(RenderObjectKey key)

returns the IRenderObjectInfo that is mapped to the supplied key parameter. If it is the first request for this key, a new IRenderObjectInfo will be created by this container. The supplied key will be used as the RenderObjectKey attribute of this new object. Each following request will receive the same instance of the IRenderObjectInfo that was created for the first call.

Parameters:

key -

Returns:

getRenderObjects

public RenderObjectInfoList getRenderObjects(IRenderObjectInfo.RenderObjectCategory category)

Parameters:

category - the category to retrieve objects for, must not be null

Returns:

a list containing only IRenderObject instances that have the specified category in their RenderObjectKey. If no IRenderObject has been defined for this category, an empty list will be returned, but never null. For each call, a new List instance will be created.

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/frwk	api	EP-KM-CM