com.sapportals.wcm.service.propertyconfig
Interface IPropertyRendererProxy

[contained in: com.sap.km.cm.service.base.par - km.shared.service.propertyconfig_api.jar]

public interface IPropertyRendererProxy

Field Summary

static java.lang.String	DEPENDENCE_EVENT
static java.lang.String	DISPATCH_EVENT

Method Summary

java.util.ArrayList	decodeValues(com.sapportals.htmlb.event.Event event) Returns the values created via the dispatchableControlIDWithValues or dispatchableControlID methods and returns the list of parameters in the same order they were when submitting them.
java.lang.String	dispatchableControlID(java.lang.String value) Adds a string to the given parameter to ensure a unique id within a DynPage under certain conditions: the idpart given is unique within this proxy.
java.lang.String	dispatchableControlIDWithValues(java.util.ArrayList values) Create an id that contains dispatch information.
java.lang.String	getUniqueComponentId(IMetaName metaName, java.lang.String key)

Field Detail

DISPATCH_EVENT

public static final java.lang.String DISPATCH_EVENT

DEPENDENCE_EVENT

public static final java.lang.String DEPENDENCE_EVENT

Method Detail

getUniqueComponentId

public java.lang.String getUniqueComponentId(IMetaName metaName,
                                             java.lang.String key)

dispatchableControlIDWithValues

public java.lang.String dispatchableControlIDWithValues(java.util.ArrayList values)
                                                 throws WcmException

Create an id that contains dispatch information.

Parameters:

controlHandler - The event handler in the control itself (not null)

values - A string array parameter that could be readed inside the event handler with decodeValues() (might be null)

Returns:

String The dispatchableControlID, created by a control.

Throws:

WdfException - Exception raised in failure situation

<{WcmException}> -

dispatchableControlID

public java.lang.String dispatchableControlID(java.lang.String value)
                                       throws WcmException

Adds a string to the given parameter to ensure a unique id within a DynPage under certain conditions:
the idpart given is unique within this proxy. This means, that no two elements that are rendered by any classes that are again rendered within this proxy must call this method with the same parameter. If several proxies are rendered within one DynPage, the page itself must ensure that the proxies are configured to create different strings to add to the given parameters. So, if Class A, rendered within proxy B calls this method, submitting String S1, the resulting String Unique1 must be different from the String Unique2, that is created when Class A, rendered within proxy C calls this method, submitting String S1

Parameters:

idpart, - must not be null.

Returns:

a String

decodeValues

public java.util.ArrayList decodeValues(com.sapportals.htmlb.event.Event event)
                                 throws WcmException

Returns the values created via the dispatchableControlIDWithValues or dispatchableControlID methods and returns the list of parameters in the same order they were when submitting them. There will be no en- or decoding done to take care of special characters. If the dispatchableControlID(String, String) method is used, a List with only one entry will be returned.

Parameters:

event - The event that contains the encoded values.

Returns:

String (cardinality = 1)