Package com.sun.portal.portletcontainer.admin.registry

Class PortletAppRegistry

java.lang.Object

com.sun.portal.portletcontainer.admin.registry.PortletAppRegistry

All Implemented Interfaces:

PortletRegistryObject, PortletRegistryTags

public class PortletAppRegistry
extends Object
implements PortletRegistryTags, PortletRegistryObject

PortletAppRegistry represents the PortletAppRegistry Element in portlet-app-registry.xml

Field Summary

Fields inherited from interface com.sun.portal.portletcontainer.admin.registry.PortletRegistryTags

ARCHIVE_KEY, ARCHIVE_NAME_KEY, ARCHIVE_TYPE_KEY, COLLECTION_TAG, CONSUMER_ID, DESCRIPTION_KEY, DESCRIPTION_MAP_KEY, DISPLAY_NAME_MAP_KEY, ENTITY_ID_PREFIX_KEY, KEYWORDS_KEY, LANG, NAME_KEY, PORTLET_APP_REGISTRY_TAG, PORTLET_APP_TAG, PORTLET_HANDLE, PORTLET_ID, PORTLET_NAME_KEY, PORTLET_WINDOW_PREFERENCE_REGISTRY_TAG, PORTLET_WINDOW_PREFERENCE_TAG, PORTLET_WINDOW_REGISTRY_TAG, PORTLET_WINDOW_TAG, PREFERENCE_PROPERTIES_KEY, PREFERENCE_READ_ONLY_KEY, PRODUCER_ENTITY_ID, PROPERTIES_TAG, REMOTE_KEY, ROLE_DESCRIPTIONS_KEY, ROLE_MAP_KEY, ROW_KEY, SHORT_TITLE_KEY, STRING_TAG, SUPPORTED_CONTENT_TYPES_KEY, SUPPORTED_LOCALES_KEY, SUPPORTS_MAP_KEY, TITLE_KEY, TRANSPORT_GUARANTEE_KEY, USER_INFO_DESCRIPTIONS_KEY, USER_INFO_MAP_KEY, USER_NAME_KEY, VALUE_KEY, VERSION_KEY, VISIBLE_KEY, WIDTH_KEY

Constructor Summary

Constructors

Constructor	Description
PortletAppRegistry()

Method Summary

Modifier and Type	Method	Description
void	addRegistryElement(PortletRegistryElement portletApp)	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.
String	getVersion()
void	read(Document document)	Read the portlet registry document and populate this object.
boolean	removeRegistryElement(PortletRegistryElement portletApp)	Remove the portlet registry element from this object.
void	setVersion(String version)
void	write(Document document)	Write the portlet registry document to the repository.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortletAppRegistry

public PortletAppRegistry()

Method Detail

read

public void read(Document document)
          throws PortletRegistryException

Description copied from interface: PortletRegistryObject

Read the portlet registry document and populate this object.

Specified by:

read in interface PortletRegistryObject

Parameters:

document - the Document

Throws:

PortletRegistryException

addRegistryElement

public void addRegistryElement(PortletRegistryElement portletApp)

Description copied from interface: PortletRegistryObject

Add the portlet registry element to this object.

Specified by:

addRegistryElement in interface PortletRegistryObject

Parameters:

portletApp - the PortletRegistryElement

getRegistryElement

public PortletRegistryElement getRegistryElement(String name)

Description copied from interface: PortletRegistryObject

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

Specified by:

getRegistryElement in interface PortletRegistryObject

Parameters:

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

Returns:

a PortletRegistryElement, the element in the portlet registry.

getRegistryElements

public List<PortletRegistryElement> getRegistryElements()

Description copied from interface: PortletRegistryObject

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

Specified by:

getRegistryElements in interface PortletRegistryObject

Returns:

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

removeRegistryElement

public boolean removeRegistryElement(PortletRegistryElement portletApp)

Description copied from interface: PortletRegistryObject

Remove the portlet registry element from this object.

Specified by:

removeRegistryElement in interface PortletRegistryObject

Parameters:

portletApp - the PortletRegistryElement

Returns:

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

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

write

public void write(Document document)

Description copied from interface: PortletRegistryObject

Write the portlet registry document to the repository.

Specified by:

write in interface PortletRegistryObject

Parameters:

document - the Document