com.novell.afw.portlet.api
Interface EbiPortletAppModel

public interface EbiPortletAppModel

Interface to represent the portlet application. The information in this class is taken from the portlet-app section of the portlet.xml and novell-portlet.xml deployment descriptors.

Since:

v5.0

Method Summary

Collection	getCustomPortletModes() Returns a Collection of EbiPortletAppAttribute objects, one for each custom portlet mode specified in the deployment descriptor.
Collection	getCustomWindowStates() Returns a Collection of EbiPortletAppAttribute objects, one for each custom portlet window state specified in the deployment descriptor.
String	getPortletAppContextName() Returns the portlet application context name of a WAR in which portlet application is located.
javax.portlet.PortletContext	getPortletContext() Returns the portlet context for the portlet application.
EbiPortletInfoManager	getPortletInfoManager() Returns the info manager that created this app model.
EbiNovellPortletModel	getPortletModel(String portletName) Returns the EbiNovellPortletModel object for the name passed in.
Collection	getPortletModels() Returns a Collection of PortletModels, one for each portlet deployed in this application.
String	getProducerID() Returns the producer ID for the portlet app.
Collection	getSecurityConstraints() Returns a Collection of PortletAppSecurityContraint objects, one for each constraint specified in the deployment descriptor.
Collection	getUserAttributes() Returns a Collection of EbiPortletAppAttribute objects, one for each user attribute specified in the deployment descriptor.

Method Detail

getProducerID

public String getProducerID()

Returns the producer ID for the portlet app. For a local portlet the producer ID is the context name of the associated WAR. This ID will be propagated to all PortletModels produced by this application model.

Returns:

the producer ID.

Since:

v5.0

getPortletAppContextName

public String getPortletAppContextName()

Returns the portlet application context name of a WAR in which portlet application is located. This name will be propagated to all PortletModels produced by this application model.

Returns:

the portlet application context name.

Since:

v5.0

getPortletModel

public EbiNovellPortletModel getPortletModel(String portletName)

Returns the EbiNovellPortletModel object for the name passed in. If the name is not a valid portlet name in the deployment descriptor, null will be returned.

Parameters:

portletName - String name of the portlet for which the Model should be returned.

Returns:

EbiNovellPortletModel representing the deployed information about the portlet named, or null if the portlet name did not reference a valid portlet in the portlet application.

Since:

v5.0

getPortletModels

public Collection getPortletModels()

Returns a Collection of PortletModels, one for each portlet deployed in this application.

Returns:

Collection of PortletModels, the Collection will never be null and will always contain at a minumum one object.

Since:

v5.0

getCustomPortletModes

public Collection getCustomPortletModes()

Returns a Collection of EbiPortletAppAttribute objects, one for each custom portlet mode specified in the deployment descriptor.

Returns:

Collection of EbiPortletAppAttribute, or null if there are no custom modes specified.

Since:

v5.0

getCustomWindowStates

public Collection getCustomWindowStates()

Returns a Collection of EbiPortletAppAttribute objects, one for each custom portlet window state specified in the deployment descriptor.

Returns:

Collection of EbiPortletAppAttribute, or null if there are no custom window stated specified.

Since:

v5.0

getUserAttributes

public Collection getUserAttributes()

Returns a Collection of EbiPortletAppAttribute objects, one for each user attribute specified in the deployment descriptor.

Returns:

Collection of EbiPortletAppAttribute, or null if there are no user attributes specified.

Since:

v5.0

getSecurityConstraints

public Collection getSecurityConstraints()

Returns a Collection of PortletAppSecurityContraint objects, one for each constraint specified in the deployment descriptor.

Returns:

Collection of PortletAppSecurityContraint, or null if there are no security contraints specified.

Since:

v5.0

getPortletContext

public javax.portlet.PortletContext getPortletContext()

Returns the portlet context for the portlet application.

Returns:

Since:

v5.0

getPortletInfoManager

public EbiPortletInfoManager getPortletInfoManager()

Returns the info manager that created this app model.

Returns:

EbiPortletInfoManager associated with the app model.