com.novell.afw.portlet.api
Interface EbiPortletEntity

All Superinterfaces:

Serializable

public interface EbiPortletEntity

extends Serializable

The PortletEntity interface provides identifiers to identify a specific portlet instance.

Since:

v5.0

Field Summary

static String

EL_PORTLET_ENTITY Element Type for ACL-Based security.

Method Summary

String	getConsumerID() Gets the servlet context name of the consumer war (portal war).
String	getInstanceID() Gets the identifier that specifies this portlet instance.
String	getPortletAppContextName() Gets a portlet application context name for the associated producer.
String	getPortletContainerType() Gets the associated portlet container Type.
String	getPortletHandle() Gets the portlet handle that is assigned for this portlet instance.
String	getPortletID() Gets the portlet identifier for the portlet registration that is associated with this instance.
String	getPortletName() Gets the portlet name for this portlet instance.
String	getProducerID() Gets the identifier of the associate producer.
com.novell.afw.wsrp.core.Templates	getURLTemplates() Gets the URL templates specified for this portlet instance.
void	setPortletAppContextName(String contextName) Sets the associated portlet name context name.
void	setPortletContainerType(String containerType) Sets the associated portlet container type.
void	setPortletHandle(String portletHandle) Sets the portlet handle for this portlet instance.
void	setURLTemplates(com.novell.afw.wsrp.core.Templates urlTemplates) Sets the URL templates for this portlet instance.

Field Detail

EL_PORTLET_ENTITY

public static final String EL_PORTLET_ENTITY

Element Type for ACL-Based security.

Since:

v5.0

Method Detail

getPortletID

public String getPortletID()

Gets the portlet identifier for the portlet registration that is associated with this instance.

Returns:

the portlet identifier of the associated portlet registration.

Since:

v5.0

getPortletHandle

public String getPortletHandle()

Gets the portlet handle that is assigned for this portlet instance.

Returns:

the portlet handle for this instance.

Since:

v5.0

getPortletContainerType

public String getPortletContainerType()

Gets the associated portlet container Type.

Returns:

the portlet container type.

Since:

v5.0

getProducerID

public String getProducerID()

Gets the identifier of the associate producer. If the producer is a portlet producer, then the producer ID is the servlet context name of the producer WAR. If the producer is a WSRP producer, then the producer ID can either be the registration handle or the producer URL, depending on whether the producer requires a consumer registration.

Returns:

the producer identifier.

Since:

v5.0

getPortletAppContextName

public String getPortletAppContextName()

Gets a portlet application context name for the associated producer. (for WSRP producer only)

Returns:

a portlet application context name.

Since:

v5.0

getPortletName

public String getPortletName()

Gets the portlet name for this portlet instance.

Returns:

the portlet name.

Since:

v5.0

getInstanceID

public String getInstanceID()

Gets the identifier that specifies this portlet instance. (This identifier is the same as the portlet handle except for the WSRP portlets.)

Returns:

the unique indentifier for this instance.

Since:

v5.0

getConsumerID

public String getConsumerID()

Gets the servlet context name of the consumer war (portal war).

Returns:

the consumer identifier.

Since:

v5.0

getURLTemplates

public com.novell.afw.wsrp.core.Templates getURLTemplates()

Gets the URL templates specified for this portlet instance.

Returns:

the Templates object for this portlet instance.

Since:

v5.0

setPortletAppContextName

public void setPortletAppContextName(String contextName)

Sets the associated portlet name context name. (for WSRP producer only)

Parameters:

context - a portlet application context name for the WSRP producer.

Since:

v5.0

setPortletHandle

public void setPortletHandle(String portletHandle)

Sets the portlet handle for this portlet instance.

Parameters:

portletHandle - a portlet handle.

Since:

v5.0

setPortletContainerType

public void setPortletContainerType(String containerType)

Sets the associated portlet container type.

Parameters:

containerType - a portlet container type

Since:

v5.0

setURLTemplates

public void setURLTemplates(com.novell.afw.wsrp.core.Templates urlTemplates)

Sets the URL templates for this portlet instance.

Parameters:

urlTemplates - an Templates object, that is the url template used for this instance

Since:

v5.0