com.novell.afw.portlet.api
Interface EbiPortletProducerInfo

All Superinterfaces:

Cloneable, EbiElement, EbiFrameworkElement, Serializable

public interface EbiPortletProducerInfo

extends EbiFrameworkElement

This interface is for portlet producer info used by portlet consumer registry.

Since:

v5.0

Field Summary

static String

EL_PORTLET_PRODUCER_INFO portlet producer info element type

Method Summary

void	enable(boolean status) Enables the portlet application if status passed in is true.
String	getPortletProducerID() Gets portlet producer ID.
boolean	isAccessible() Check if the portlet producer is accessible from the application server.
boolean	isEnabled() Checks if the portlet producer is allowed to be accessed.
void	setPortletProducerID(String producerID) Sets the portlet producer ID.

Methods implemented from interface com.sssw.fw.api.EbiFrameworkElement

getElementUUID, getLastModified, getLastModifiedBy, isEqualTo, isReadOnly, resetReadOnly, setLastModified, setLastModifiedBy, setReadOnly

Methods implemented from interface com.sssw.fw.api.EbiElement

getType

Field Detail

EL_PORTLET_PRODUCER_INFO

public static final String EL_PORTLET_PRODUCER_INFO

portlet producer info element type

Since:

v5.0

Method Detail

getPortletProducerID

public String getPortletProducerID()

Gets portlet producer ID. This is the servlet context name of the portlet producer WAR.

Returns:

the portlet producer ID.

Since:

v5.0

isEnabled

public boolean isEnabled()

Checks if the portlet producer is allowed to be accessed.

Returns:

true if the portlet application is registered and enabled, false otherwise.

Since:

v5.0

isAccessible

public boolean isAccessible()

Check if the portlet producer is accessible from the application server.

Returns:

true if the portlet application is accessible, false otherwise.

Since:

v5.0

setPortletProducerID

public void setPortletProducerID(String producerID)

Sets the portlet producer ID.

Parameters:

producerID - a portlet producer ID.

Since:

v5.0

enable

public void enable(boolean status)

Enables the portlet application if status passed in is true. Otherwise, disable it.

Parameters:

status - a flag to tell whether to enable or disable the portlet app.

Since:

v5.0