Package com.sun.portal.portletcontainer.admin

Interface PortletRegistryElement

All Known Implementing Classes:

AbstractPortletRegistryElement, PortletApp, PortletWindow, PortletWindowPreference

public interface PortletRegistryElement

PortletRegistryElement represents a element in the portlet registry files. The element can be PortletApp, PortletWindow or PortletWindowPreference

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getCollectionProperty(String key)	Returns the values contained in the Collection tag specified by the key.
String	getLang()	Returns the value of the "lang" attribute for the String tag specified by the key.
String	getName()	Returns the value of "name" attribute of the registry element
String	getPortletName()	Returns the value of "portletName" attribute of the registry element
String	getRemote()	Returns the value of "isRemote" attribute of the registry element
String	getStringProperty(String key)	Returns the value of the "name" attribute for the String tag specified by the key.
String	getUserName()	Returns the value of "userName" attribute of the registry element
void	setCollectionProperty(String key, List<String> values)	Set the values for the Collection tag specified by the key.
void	setCollectionProperty(String key, Map<String,Object> values)	Set the values for the Collection tag specified by the key.
void	setLang(String lang)	Set the value of the "lang" attribute of the String tag.
void	setName(String name)	Set the value of the "name" attribute of the registry element.
void	setPortletName(String portletName)	Set the value of the "portletName" attribute of the registry element.
void	setRemote(String isRemote)	Set the value of the "isRemote" attribute of the registry element.
void	setStringProperty(String key, String value)
void	setUserName(String userName)	Set the value of the "userName" attribute of the registry element.

Method Detail

setName

void setName(String name)

Set the value of the "name" attribute of the registry element.

Parameters:

name - the value of the "name" attribute of the registry element.

getName

String getName()

Returns the value of "name" attribute of the registry element

Returns:

a String, the value of "name" attribute of the registry element.

setPortletName

void setPortletName(String portletName)

Set the value of the "portletName" attribute of the registry element.

Parameters:

portletName - the value of the "portletName" attribute of the registry element.

getPortletName

String getPortletName()

Returns the value of "portletName" attribute of the registry element

Returns:

a String, the value of "portletName" attribute of the registry element.

setUserName

void setUserName(String userName)

Set the value of the "userName" attribute of the registry element.

Parameters:

userName - the value of the "userName" attribute of the registry element.

getUserName

String getUserName()

Returns the value of "userName" attribute of the registry element

Returns:

a String, the value of "userName" attribute of the registry element.

setRemote

void setRemote(String isRemote)

Set the value of the "isRemote" attribute of the registry element.

Parameters:

isRemote - the value of the "isRemote" attribute of the registry element.

getRemote

String getRemote()

Returns the value of "isRemote" attribute of the registry element

Returns:

a String, the value of "isRemote" attribute of the registry element.

setCollectionProperty

void setCollectionProperty(String key,
                           List<String> values)
                    throws PortletRegistryException

Set the values for the Collection tag specified by the key. This Collection tag is contained within the registry element. Each value in the list is represented as a value of the "value" attribute in the String tag. This String tag is contained within the Collection tag.

Parameters:

key - the value for the "name" attribute of the Collection tag.

values - represented by "value" attribute of the String tags.

Throws:

PortletRegistryException

setCollectionProperty

void setCollectionProperty(String key,
                           Map<String,Object> values)
                    throws PortletRegistryException

Set the values for the Collection tag specified by the key. This Collection tag is contained within the registry element. Each key in the Map is represented as a value of the "name" attribute in the String tag and value for the key is represented as a value for the "value" attribute in the String tag. This String tag is contained within the Collection tag

Parameters:

key - the value for the "name" attribute of the Collection tag.

values - represented by "name" and "value" attribute of the String tags.

Throws:

PortletRegistryException

getCollectionProperty

Map<String,Object> getCollectionProperty(String key)
                                        throws PortletRegistryException

Returns the values contained in the Collection tag specified by the key. The Collection tag contains String tags. This String tag has either "name" attribute or both "name" and "value" attribute. If the String tag has only "name" attribute, the Map returned contains the value of the "name" attribute as both key and value. If the String tag has both "name" and "value" attribute, the Map returned contains the value of the "name" attribute as key and value of the "value" attribute as value.

Returns:

a Map, the value of attributes "name" and "value" of String tag.

Throws:

PortletRegistryException

setStringProperty

void setStringProperty(String key,
                       String value)
                throws PortletRegistryException

Throws:

PortletRegistryException

getStringProperty

String getStringProperty(String key)
                  throws PortletRegistryException

Returns the value of the "name" attribute for the String tag specified by the key.

Returns:

a String, the value represented by the "name" attribute for the String tag

Throws:

PortletRegistryException

setLang

void setLang(String lang)

Set the value of the "lang" attribute of the String tag.

Parameters:

lang - the value represented by the "lang" attribute for the String tag

getLang

String getLang()

Returns the value of the "lang" attribute for the String tag specified by the key.

Returns:

a String, the value represented by the "lang" attribute for the String tag