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

Interface IResourceBasedInfo

public interface IResourceBasedInfo

Method Summary

void	addUnstructuredInfo(Field field) adds a field to the list of unstructed information.
void	addUnstructuredInfo(String uniqueKey, String label, String value)
Status	getStatus()
List	getUnstructuredInfo()
void	setStatus(Status status)

Method Detail

addUnstructuredInfo

void addUnstructuredInfo(Field field)

adds a field to the list of unstructed information. This list allows rendering objects to add information that is specific to them (e.g. for an ILayoutController the list of registered Control instances). These objects do not fit in one of the other buckets of information and are therefore added to this list.

Parameters:

field - an entry for the renderer-specific information for this RenderObjectData, must not be null

addUnstructuredInfo

void addUnstructuredInfo(String uniqueKey,
                         String label,
                         String value)

getUnstructuredInfo

List getUnstructuredInfo()

Returns:

a List implementation that only contains objects that implement the IField interface. The list will not contain null elements. The ordering of the list might be changed between calls.

getStatus

Status getStatus()

Returns:

the status for this info object. The default return value should be Status.OK. It should be changed to a different severity, if an added field indicates some problem. Must not return null.

setStatus

void setStatus(Status status)

Parameters:

status - the new status for this info object. It will not modify the status of this object, if it is null.

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