com.ibm.portal.portletmodel.admin
Interface AdminPortletModel

All Known Subinterfaces:

AdminPortletModelController

public interface AdminPortletModel

This interface provides administrative access and lookup methods for the global levels of portlet configuration that are not specific to a particular aggregation module.

The resulting model is scoped to a particular request and user context and contains only those resources that are visible in that context.

Since:

6.0.1

Method Summary

Portlet	getPortlet(PortletDefinition portletDefinition) Return the portlet that represents the deployed code unit for the given portlet definition
PortletDefinitionList<PortletDefinition>	getPortletDefinitionList() Return a model that gives access to the portlet definitions that are accessible in the context of this portlet model.
PortletList<Portlet>	getPortletList() Return a model that gives access to the portlets that are accessible in the context of this portlet model.
PortletWindowList<PortletWindow>	getPortletWindowList() Return a model that gives access to the portlet windows that are accessible in the context of this portlet model.
WebApplication	getWebApplication(Portlet portlet) Returns the web application that represents the deployment unit for the given portlet
WebApplicationList<WebApplication>	getWebApplicationList() Return a model that gives access to the web applications that are accessible in the context of this portlet model.

Method Detail

getPortletWindowList

PortletWindowList<PortletWindow> getPortletWindowList()
                                                      throws ModelException

Return a model that gives access to the portlet windows that are accessible in the context of this portlet model.

Returns:

a list of accessible PortletWindow objects; never returns null

Throws:

ModelException - in case the portlet window list cannot be obtained

Since:

7.0.0

getPortlet

Portlet getPortlet(PortletDefinition portletDefinition)
                   throws ModelException

Return the portlet that represents the deployed code unit for the given portlet definition

Returns:

a Portlet; never returns null.

Throws:

ModelException - in case the portlet cannot be obtained

getWebApplication

WebApplication getWebApplication(Portlet portlet)
                                 throws ModelException

Returns the web application that represents the deployment unit for the given portlet

Returns:

a WebApplications; never returns null

Throws:

ModelException - in case the web application cannot be obtained

getPortletDefinitionList

PortletDefinitionList<PortletDefinition> getPortletDefinitionList()
                                                                  throws ModelException

Return a model that gives access to the portlet definitions that are accessible in the context of this portlet model.

Returns:

a list of accessible PortletDefinition objects; never returns null

Throws:

ModelException - in case the portlet definition list cannot be obtained

getPortletList

PortletList<Portlet> getPortletList()
                                    throws ModelException

Return a model that gives access to the portlets that are accessible in the context of this portlet model.

Returns:

a list of accessible Portlet objects; never returns null

Throws:

ModelException - in case the portlet list cannot be obtained

getWebApplicationList

WebApplicationList<WebApplication> getWebApplicationList()
                                                         throws ModelException

Return a model that gives access to the web applications that are accessible in the context of this portlet model.

Returns:

a list of accessible WebApplication objects; never returns null

Throws:

ModelException - in case the application list cannot be obtained