org.apache.pluto.om.portlet
Interface PortletApplicationDefinition

All Superinterfaces:
Model

public interface PortletApplicationDefinition
extends Model

This interface provides access to a portlet application and its attributes. A portlet application is defined in the portlet.xml of a portlet application archive file.
Additionally, this interface allows to retrieve containing elements such as portlets.

This interface defines the model as known from the MVC pattern. Its purpose is to provide read access to the data stored in the model.


Method Summary
 ObjectID getId()
          Returns the identifier of this portlet as object id.
 PortletDefinitionList getPortletDefinitionList()
          Returns all portlets contained in this portlet application.
 java.lang.String getVersion()
          Returns the version of this portlet application.
 WebApplicationDefinition getWebApplicationDefinition()
          Returns the corresponding web application to this portlet application.
 

Method Detail

getId

public ObjectID getId()
Returns the identifier of this portlet as object id. The return value cannot be NULL.

Returns:
the object identifier

getVersion

public java.lang.String getVersion()
Returns the version of this portlet application. The return value may be NULL.

Returns:
the version

getPortletDefinitionList

public PortletDefinitionList getPortletDefinitionList()
Returns all portlets contained in this portlet application. The return value cannot be NULL.

Returns:
a collection containing PortletDefinition objects

getWebApplicationDefinition

public WebApplicationDefinition getWebApplicationDefinition()
Returns the corresponding web application to this portlet application. The return value cannot be NULL.

Returns:
a web application


Copyright © 2003-2006 . All Rights Reserved.