Package com.sun.portal.portletcontainer.admin

Interface PortletRegistryObject

All Known Implementing Classes:

PortletAppRegistry, PortletWindowPreferenceRegistry, PortletWindowRegistry

public interface PortletRegistryObject

PortletRegistryObject represents a Portlet registry document. It can be either PortletAppRegistry, PortletWindowRegistry or PortletWindowPreferenceRegistry.

Method Summary

Modifier and Type	Method	Description
void	addRegistryElement(PortletRegistryElement portletRegistryElement)	Add the portlet registry element to this object.
PortletRegistryElement	getRegistryElement(String name)	Returns the portlet registry element for the specified name.
List<PortletRegistryElement>	getRegistryElements()	Returns a list of all portlet registry elements in the portlet registry.
void	read(Document document)	Read the portlet registry document and populate this object.
boolean	removeRegistryElement(PortletRegistryElement portletRegistryElement)	Remove the portlet registry element from this object.
void	write(Document document)	Write the portlet registry document to the repository.

Method Detail

write

void write(Document document)
    throws PortletRegistryException

Write the portlet registry document to the repository.

Parameters:

document - the Document

Throws:

PortletRegistryException

read

void read(Document document)
   throws PortletRegistryException

Read the portlet registry document and populate this object.

Parameters:

document - the Document

Throws:

PortletRegistryException

addRegistryElement

void addRegistryElement(PortletRegistryElement portletRegistryElement)

Add the portlet registry element to this object.

Parameters:

portletRegistryElement - the PortletRegistryElement

removeRegistryElement

boolean removeRegistryElement(PortletRegistryElement portletRegistryElement)

Remove the portlet registry element from this object.

Parameters:

portletRegistryElement - the PortletRegistryElement

Returns:

a true, if the portlet registry element is successfully removed.

getRegistryElement

PortletRegistryElement getRegistryElement(String name)

Returns the portlet registry element for the specified name. This can be either be PortletAppRegistry, PortletWindowRegistry or PortletWindowPreferenceRegistry objects.

Parameters:

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

Returns:

a PortletRegistryElement, the element in the portlet registry.

getRegistryElements

List<PortletRegistryElement> getRegistryElements()

Returns a list of all portlet registry elements in the portlet registry.

Returns:

a List of all portlet registry elements in the portlet registr.