org.apache.jetspeed.om.common.portlet
Interface PortletApplication

All Superinterfaces:
org.apache.pluto.om.Model, org.apache.pluto.om.portlet.PortletApplicationDefinition
All Known Subinterfaces:
MutablePortletApplication

public interface PortletApplication
extends org.apache.pluto.om.portlet.PortletApplicationDefinition

PortletApplication Extends the org.apache.pluto.om.portlet.PortletApplicationDefinition interface adding methods for those attributes that do not have them so as to make manipulating the portlet OM easier.

Version:
$Id: PortletApplication.java 186948 2004-07-06 21:32:33Z taylor $
Author:
David Sean Taylor

Method Summary
 String getApplicationIdentifier()
           
 int getApplicationType()
          Gets the Portlet Application type.
 String getDescription()
           
 Collection getJetspeedServices()
          Gets a collection of all Jetspeed Services allowed for this application.
 GenericMetadata getMetadata()
          Returns the metadata from the extended jetspeed-portlet.xml
 String getName()
          Gets the name of the Portlet Application.
 org.apache.pluto.om.portlet.PortletDefinition getPortletDefinitionByName(String name)
          Finds a portlet by portlet name, searching this portlet application's collection.
 Collection getPortletDefinitions()
           
 Collection getUserAttributeRefs()
          Gets the collection of user attribute refs associated with this portlet application.
 Collection getUserAttributes()
          Gets the collection of user attributes associated with this portlet application.
 
Methods inherited from interface org.apache.pluto.om.portlet.PortletApplicationDefinition
getId, getPortletDefinitionList, getVersion, getWebApplicationDefinition
 

Method Detail

getMetadata

public GenericMetadata getMetadata()
Returns the metadata from the extended jetspeed-portlet.xml

Returns:
Jetspeed specific metadata

getName

public String getName()
Gets the name of the Portlet Application.

Returns:
Name of the application

getPortletDefinitions

public Collection getPortletDefinitions()
Returns:

getPortletDefinitionByName

public org.apache.pluto.om.portlet.PortletDefinition getPortletDefinitionByName(String name)
Finds a portlet by portlet name, searching this portlet application's collection.

Parameters:
name - The portlet name.
Returns:
A Portlet Definition

getUserAttributeRefs

public Collection getUserAttributeRefs()

Gets the collection of user attribute refs associated with this portlet application.


getUserAttributes

public Collection getUserAttributes()

Gets the collection of user attributes associated with this portlet application.


getApplicationIdentifier

public String getApplicationIdentifier()

getDescription

public String getDescription()
Returns:

getApplicationType

public int getApplicationType()
Gets the Portlet Application type. Valid values are:

MutablePortletApplication.WEBAPP - A standard web application, stored in the web application server's web application space.

MutablePortletApplication.LOCAL - A local portlet application stored within Jetspeed's web application.

Returns:
The type of portlet application.

getJetspeedServices

public Collection getJetspeedServices()
Gets a collection of all Jetspeed Services allowed for this application.

Returns:
The collection of services of type JetspeedServiceReference.
See Also:
JetspeedServiceReference


Copyright © 1999-2005 Apache Software Foundation. All Rights Reserved.