com.novell.afw.portlet.api
Interface EbiPortletRegistration

public interface EbiPortletRegistration

The EbiPortletRegistration interface provides Portlet ID assigned by a portlet registration, and has access to EbiPortletModel interface for the portlet deployment descriptor.

Since:

v5.0

See Also:

PortletModel

Field Summary

static String

EL_PORTLET_REGISTRATION Element Type for ACL-Based security.

Method Summary

String	getPortletHandle() Gets the portlet handle for this portlet registration.
String	getPortletID() Gets the portlet ID for this portlet registration.
EbiPortletModel	getPortletModel() Gets the portlet Model associated with this portlet registration.
void	setPortletHandle(String portletHandle) Sets the portlet Handle.
void	setPortletID(String portletID) Sets the portlet ID.
void	setPortletModel(EbiPortletModel portletModel) Sets a portlet Model.

Field Detail

EL_PORTLET_REGISTRATION

public static final String EL_PORTLET_REGISTRATION

Element Type for ACL-Based security.

Since:

v5.0

Method Detail

getPortletID

public String getPortletID()

Gets the portlet ID for this portlet registration. The portlet ID is a unique identifier of a portlet (definition). The portal/aggregation engine uses Portlet IDs to easily identify registered portlets without providing producer information.

Returns:

the portlet identifier for a portlet registration.

Since:

v5.0

setPortletID

public void setPortletID(String portletID)

Sets the portlet ID. The portlet ID is a unique identifier for the specified portlet registration.

Parameters:

portletID - a unique portlet identifier assigned by a portlet registration.

Since:

v5.0

getPortletHandle

public String getPortletHandle()

Gets the portlet handle for this portlet registration. The portlet handle is provided by the portlet producer that owns the portlet.

Returns:

the portlet handle from a portlet registration.

Since:

v5.0

setPortletHandle

public void setPortletHandle(String portletHandle)

Sets the portlet Handle. The portlet handle is provided by the portlet producer.

Parameters:

portletHandle - a portlet handle returned by portlet producer after completing the portlet registration operation.

Since:

v5.0

getPortletModel

public EbiPortletModel getPortletModel()

Gets the portlet Model associated with this portlet registration.

Returns:

a EbiPortletModel object.

Since:

v5.0

See Also:

EbiPortletModel

setPortletModel

public void setPortletModel(EbiPortletModel portletModel)

Sets a portlet Model. The portlet Model contains the portlet definition that is associated with this portlet registration.

Parameters:

portletModel - a EbiPortletModel object that presents the portlet defnition associated with this portlet registration.

Since:

v5.0