com.pega.pegarules.pub.runtime

Interface IUIComponentMetadata

public interface IUIComponentMetadata

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PY_TEMPLATES
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
void	addMetadataInArray(java.lang.String key, IUIComponentMetadata metadata) Adds metdata to the list
void	adoptJSON(java.lang.String jsonString)
IUIComponentInfo	getInfo()
java.lang.String	getJSON() Returns the json representation of metadata.
com.google.gson.JsonObject	getNestedObject(java.lang.String key)
java.lang.String	getNestedProperty(java.lang.String key) returns the value of the nested property
com.google.gson.JsonObject	getObject() Returns the data as Map
java.lang.String	getString(java.lang.String key) Get the value with this key.
java.lang.String	getStringIfPresent(java.lang.String aKey) Get the value with this key.
void	put(java.lang.String key, boolean value)
void	put(java.lang.String key, IUIComponentMetadata[] metadatas)
void	put(java.lang.String key, java.lang.String value)
void	putMetadata(java.lang.String key, IUIComponentMetadata metadata) Embed the metadata.
void	putNestedProperty(java.lang.String key, java.lang.String value)
void	putString(java.lang.String key, java.lang.String value) Store the values as key:value, any existing value will be overridden.
java.lang.Object	remove(java.lang.String key) Removes the property from metadata

Field Detail

VERSION

static final java.lang.String VERSION

PY_TEMPLATES

static final java.lang.String PY_TEMPLATES

See Also:

Constant Field Values

Method Detail

putString

void putString(java.lang.String key,
               java.lang.String value)

Store the values as key:value, any existing value will be overridden.

Parameters:

key -

value -

put

void put(java.lang.String key,
         boolean value)

Parameters:

key -

value -

put

void put(java.lang.String key,
         java.lang.String value)

Parameters:

key -

value -

getString

java.lang.String getString(java.lang.String key)

Get the value with this key. If not exists then returns empty string.

Parameters:

key -

Returns:

String.

getStringIfPresent

java.lang.String getStringIfPresent(java.lang.String aKey)

Get the value with this key. If not exists then returns null.

Parameters:

aKey -

Returns:

String

getJSON

java.lang.String getJSON()

Returns the json representation of metadata.

Returns:

json string

getObject

com.google.gson.JsonObject getObject()

Returns the data as Map

Returns:

StringMap

putMetadata

void putMetadata(java.lang.String key,
                 IUIComponentMetadata metadata)

Embed the metadata.

Parameters:

key -

metadata -

addMetadataInArray

void addMetadataInArray(java.lang.String key,
                        IUIComponentMetadata metadata)

Adds metdata to the list

Parameters:

key -

metadata -

putNestedProperty

void putNestedProperty(java.lang.String key,
                       java.lang.String value)

Parameters:

key -

value - ex: putNestedProperty("topPage.property","somevalue")

getNestedProperty

java.lang.String getNestedProperty(java.lang.String key)

returns the value of the nested property

Parameters:

key -

Returns:

String

put

void put(java.lang.String key,
         IUIComponentMetadata[] metadatas)

Parameters:

key -

metadatas -

adoptJSON

void adoptJSON(java.lang.String jsonString)

Parameters:

jsonString -

getInfo

IUIComponentInfo getInfo()

Returns:

Returns component info

remove

java.lang.Object remove(java.lang.String key)

Removes the property from metadata

Parameters:

key -

Returns:

removed item

getNestedObject

com.google.gson.JsonObject getNestedObject(java.lang.String key)