fr.paris.lutece.portal.service.rbac

Class ResourceIdService

java.lang.Object

fr.paris.lutece.portal.service.rbac.ResourceIdService

Direct Known Subclasses:

AdminUserResourceIdService, InsertResourceIdService, PageResourceIdService, PortletResourceIdService, SearchResourceIdService, XslExportResourceIdService

public abstract class ResourceIdService
extends Object

This class gives the methods to implement in order to allow the restitution of the ids and labels for a given resource type.

Constructor Summary

Constructors

Constructor and Description
ResourceIdService()

Method Summary

Modifier and Type	Method and Description
String	getPluginName() Gets the name of the plugin associated
abstract ReferenceList	getResourceIdList(Locale locale) Provide the list of all resources (id - label)
abstract String	getTitle(String strId, Locale locale) Provide the title of a resource given its id
abstract void	register() This method should register permissions and resource type
void	setPluginName(String strPluginName) Sets the name of the plugin associated

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceIdService

public ResourceIdService()

Method Detail

register

public abstract void register()

This method should register permissions and resource type

getResourceIdList

public abstract ReferenceList getResourceIdList(Locale locale)

Provide the list of all resources (id - label)

Parameters:

locale - The locale

Returns:

the list of all resources available for restricted access

getTitle

public abstract String getTitle(String strId,
                                Locale locale)

Provide the title of a resource given its id

Parameters:

locale - The locale

strId - the id of the resource

Returns:

the title the corresponding label

setPluginName

public void setPluginName(String strPluginName)

Sets the name of the plugin associated

Parameters:

strPluginName - the plugin name

getPluginName

public String getPluginName()

Gets the name of the plugin associated

Returns:

the plugin name