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

Interface IRenderObjectInfo

public interface IRenderObjectInfo

This interface combines all information that have been used during the rendering process for a certain object used within the rendering process. These objects include Control, ICollectionRenderer... The RenderObjectKey is used to identify an instance of this class during the rendering process. The different static final RenderObjectCategory constants offered reflect the different categories that roughly divide the functional aspects of classes used in the flexible UI. When adding information for a certain rendering object to an RenderObjectContainer and creating a RenderObjectKey for it, it is the programmer's responsibility to choose the best fitting category for this rendering object. This list of categories might be extended with subsequent releases. Could TypedResourceList be a 4th qualifier for ID?

Nested Class Summary

static class

IRenderObjectInfo.RenderObjectCategory defines a category to organize rendering objects in.

Field Summary

static IRenderObjectInfo.RenderObjectCategory[]	CATEGORIES a list of all available categories for the rendering process.
static IRenderObjectInfo.RenderObjectCategory	COLLECTION_RENDERER
static IRenderObjectInfo.RenderObjectCategory	COMPONENT
static IRenderObjectInfo.RenderObjectCategory	CONTROL
static IRenderObjectInfo.RenderObjectCategory	LAYOUT_CONTROLLER
static IRenderObjectInfo.RenderObjectCategory	PROPERTY_RENDERER
static IRenderObjectInfo.RenderObjectCategory	PROXY
static IRenderObjectInfo.RenderObjectCategory	RENDERER_STATUS
static IRenderObjectInfo.RenderObjectCategory	RESOURCE_RENDERER
static IRenderObjectInfo.RenderObjectCategory	RESOURCELISTFILTER
static IRenderObjectInfo.RenderObjectCategory	UICOMMANDMENU

Method Summary

RenderObjectData	getData()
RenderObjectKey	getKey()
Status	getStatus()

Field Detail

PROXY

static final IRenderObjectInfo.RenderObjectCategory PROXY

LAYOUT_CONTROLLER

static final IRenderObjectInfo.RenderObjectCategory LAYOUT_CONTROLLER

COLLECTION_RENDERER

static final IRenderObjectInfo.RenderObjectCategory COLLECTION_RENDERER

RESOURCE_RENDERER

static final IRenderObjectInfo.RenderObjectCategory RESOURCE_RENDERER

CONTROL

static final IRenderObjectInfo.RenderObjectCategory CONTROL

UICOMMANDMENU

static final IRenderObjectInfo.RenderObjectCategory UICOMMANDMENU

RESOURCELISTFILTER

static final IRenderObjectInfo.RenderObjectCategory RESOURCELISTFILTER

COMPONENT

static final IRenderObjectInfo.RenderObjectCategory COMPONENT

PROPERTY_RENDERER

static final IRenderObjectInfo.RenderObjectCategory PROPERTY_RENDERER

RENDERER_STATUS

static final IRenderObjectInfo.RenderObjectCategory RENDERER_STATUS

CATEGORIES

static final IRenderObjectInfo.RenderObjectCategory[] CATEGORIES

a list of all available categories for the rendering process. Note that the order of the entries roughly reflect the chronological (and hierarchical) order of these building blocks within the rendering process.

Method Detail

getKey

RenderObjectKey getKey()

Returns:

the key for this info object. Within a RenderObjectContainer, this key will be identical to the key used to retrieve this info object via the RenderObjectContainer's getRenderObject method. Must never return null.

getData

RenderObjectData getData()

Returns:

the data attribute of this info object. Must never return null.

getStatus

Status getStatus()

Returns:

the status provided by the RenderObjectData attribute of the implementing class. Must not return null.

Access Rights

This class can be accessed from:

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