org.osivia.portal.api.portlet

Class PortalGenericPortlet

java.lang.Object

javax.portlet.GenericPortlet

org.osivia.portal.api.portlet.PortalGenericPortlet

All Implemented Interfaces:

javax.portlet.EventPortlet, javax.portlet.Portlet, javax.portlet.PortletConfig, javax.portlet.ResourceServingPortlet

public abstract class PortalGenericPortlet
extends javax.portlet.GenericPortlet

Abstract portlet class used to access basic services such as notification, directories, etc.

Author:

lbillon

Constructor Summary

Constructors

Constructor and Description
PortalGenericPortlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addNotification(PortalControllerContext pcc, String label, NotificationsType notificationType) Display a notification with a key label
protected void	addNotification(PortalControllerContext pcc, String label, NotificationsType notificationType, Object... args) Display a notification with a key label and variables
IBundleFactory	getBundleFactory()
IDirectoryService	getDirectoryService()
IMenubarService	getMenubarService()
protected String	getMessage(PortalControllerContext pcc, String label) Return a label in resources files
protected String	getMessage(PortalControllerContext pcc, String label, Object... args) Return a label in resources files
INotificationsService	getNotificationsService()
IPortalUrlFactory	getPortalUrlFactory()
ITraceService	getTraceService()

Methods inherited from class javax.portlet.GenericPortlet

destroy, doDispatch, doEdit, doHeaders, doHelp, doView, getContainerRuntimeOptions, getDefaultNamespace, getInitParameter, getInitParameterNames, getNextPossiblePortletModes, getPortletConfig, getPortletContext, getPortletName, getProcessingEventQNames, getPublicRenderParameterNames, getPublishingEventQNames, getResourceBundle, getSupportedLocales, getTitle, init, init, processAction, processEvent, render, serveResource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortalGenericPortlet

public PortalGenericPortlet()

Method Detail

getDirectoryService

public IDirectoryService getDirectoryService()

getTraceService

public ITraceService getTraceService()

Returns:

the traceService via the locator

getNotificationsService

public INotificationsService getNotificationsService()

Returns:

the notificationsService

getBundleFactory

public IBundleFactory getBundleFactory()

Returns:

the bundleFactory

getPortalUrlFactory

public IPortalUrlFactory getPortalUrlFactory()

Returns:

the portalUrlFactory

getMenubarService

public IMenubarService getMenubarService()

Returns:

the menubarService

getMessage

protected String getMessage(PortalControllerContext pcc,
                String label)

Return a label in resources files

Parameters:

pcc -

label - the key in resources bundle

Returns:

the label translated

getMessage

protected String getMessage(PortalControllerContext pcc,
                String label,
                Object... args)

Return a label in resources files

Parameters:

pcc -

label - the key in resources bundle

args - some args

Returns:

the label translated

addNotification

protected void addNotification(PortalControllerContext pcc,
                   String label,
                   NotificationsType notificationType)

Display a notification with a key label

Parameters:

pcc -

label - the key in resources bundle

notificationType - the notification type

addNotification

protected void addNotification(PortalControllerContext pcc,
                   String label,
                   NotificationsType notificationType,
                   Object... args)

Display a notification with a key label and variables

Parameters:

pcc -

label - the key in resources bundle

notificationType - the notification type

args - variables