com.sapportals.wcm.service.propertystructure

Interface IStructuredGroupRenderer

All Known Implementing Classes:

AbstractGroupRenderer, ApplicationPropertiesGroupRenderer, CustomGroupRenderer, LifeTimeGroupRenderer, ResourcePropertiesGroupRenderer, SimpleGroupRenderer, StandardGroupRenderer, UnmodelledPropertiesGroupRenderer

public interface IStructuredGroupRenderer

Renderer for a structured group.

Method Summary

IPropertyMap	getProperties(IMetaContext metaContext, com.sapportals.htmlb.page.DynPage dynPage) Gets the properties with their entered values after the response has been returned.
String[]	processEvent(com.sapportals.htmlb.event.Event event, IMetaContext metaContext, com.sapportals.htmlb.page.DynPage dynPage) Validates the group content
com.sapportals.htmlb.Component	render(IMetaContext metaContext) Renders the structured group.
void	save(IMetaContext metaContext, com.sapportals.htmlb.page.DynPage dynPage) Saves the content of the structured group.
void	setGroup(IStructuredGroup structuredGroup) Set the structured group for that the renderer is configured.
String[]	validate(IMetaContext metaContext, com.sapportals.htmlb.page.DynPage dynPage) Validates the group content

Method Detail

render

com.sapportals.htmlb.Component render(IMetaContext metaContext)
                                      throws PropertyStructureServiceException

Renders the structured group.

Parameters:

metaContext - context information for the renderer

Returns:

htmlb component as result of the rendering process

Throws:

PropertyStructureServiceException

getProperties

IPropertyMap getProperties(IMetaContext metaContext,
                           com.sapportals.htmlb.page.DynPage dynPage)
                           throws PropertyStructureServiceException

Gets the properties with their entered values after the response has been returned.

Parameters:

metaContext - context information for the renderer

dynPage - htmlb dynpage that contains the response document

Returns:

map of properties with their entered values

Throws:

PropertyStructureServiceException

validate

String[] validate(IMetaContext metaContext,
                  com.sapportals.htmlb.page.DynPage dynPage)
                  throws PropertyStructureServiceException

Validates the group content

Parameters:

metaContext - context information for the renderer

dynPage - htmlb dynpage that contains the response document

Returns:

localized error messages or null

Throws:

PropertyStructureServiceException

save

void save(IMetaContext metaContext,
          com.sapportals.htmlb.page.DynPage dynPage)
          throws PropertyStructureServiceException

Saves the content of the structured group.

Parameters:

metaContext - context information for the renderer

dynPage - htmlb dynpage that contains the response document

Throws:

PropertyStructureServiceException

setGroup

void setGroup(IStructuredGroup structuredGroup)

Set the structured group for that the renderer is configured.

Parameters:

structuredGroup - group information

processEvent

String[] processEvent(com.sapportals.htmlb.event.Event event,
                      IMetaContext metaContext,
                      com.sapportals.htmlb.page.DynPage dynPage)
                      throws PropertyStructureServiceException

Validates the group content

Parameters:

event -

metaContext - context information for the renderer

dynPage - htmlb dynpage that contains the response document

Returns:

localized error messages or null

Throws:

PropertyStructureServiceException

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